Get order details

GET

/v1/transactions/{merchant}/{site}/order-details

Request example

To get order details for a specific transaction, you'll need to supply the merchant and site associated with the transaction, as well as its fundingType and systemTransactionId.

Use the following request example to get order details for a card transaction.

curl --request GET \
     --url https://api-services.pxpfinancial.com/v1/transactions/MERCHANT-1/SITE-1/order-details?fundingType=paypal&systemTransactionId={1ed768bb-e88a-4636-91ae-67927ccbb02b} \
     --header 'accept: application/json'

Path parameters

Parameter	Description
`merchant` string required	Your unique merchant identifier, as assigned by PXP.
`site` string (≤ 20 characters) required	Your unique site identifier, as assigned by PXP.

Query parameters

Parameter	Description
`fundingType` enum required	The funding type used for this transaction. Currently, only `paypal` is supported.
`systemTransactionId` string (36 characters) required	The unique identifier assigned to this transaction by PXP.

Response example

If your request is successful, you'll receive a 200 response containing the order details.

{
  "fundingData": {
    "shippingAddress": {
      "addressLine1": "Flat 3",
      "addressLine2": "59 Southdown Rd",
      "city": "Harpenden",
      "postalCode": "AL5 1PQ",
      "county": "Hertfordshire",
      "countryCode": "GB"
    }
  },
  "merchantTransactionId": "TRANSACTION-001",
  "systemTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b",
  "providerTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b"
}

Parameter	Description
`fundingData` object	Details about the funding method.
`fundingData.shippingAddress` object	Details about the shipping address associated with the transaction.
`fundingData.shippingAddress.addressLine1` string	The first line of the shipping address.
`fundingData.shippingAddress.addressLine2` string	The second line of the shipping address.
`fundingData.shippingAddress.city` string	The city of the shipping address.
`fundingData.shippingAddress.postalCode` string	The postal or ZIP code of the shipping address.
`fundingData.shippingAddress.county` string	The county of the shipping address.
`fundingData.shippingAddress.countryCode` string (2 characters)	The country code of the shipping address, in ISO-3166-1 alpha-2 format.
`merchantTransactionId` string (≤ 50 characters)	The unique identifier you assigned to this transaction.
`systemTransactionId` string (36 characters)	The unique identifier assigned to this transaction by PXP.
`providerTransactionId` string	The unique identifier assigned to this transaction by the provider. If the provider is PXP, then this matches the `systemTransactionId`.