Get order details

Request

Path

merchantstring, <= 10 charactersrequired

Your unique merchant identifier, as assigned by PXP.

Example:MERCHANT-1

sitestring, <= 50 charactersrequired

Your unique site identifier, as assigned by PXP.

Example:SITE-1

Query

fundingTypestringrequired

The funding type used for this transaction. Only Paypal has an order-details handler registered; other FundingType values are not supported on this endpoint.

Value:"Paypal"

Example:fundingType=Paypal

systemTransactionIdstring, [ 36 .. 40 ] characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

The unique identifier assigned to this transaction by PXP.

Example:systemTransactionId=1ed768bb-e88a-4636-91ae-67927ccbb02b

curl -i -X GET \
  'https://api-services.pxp.io/api/v1/transactions/MERCHANT-1/SITE-1/order-details?fundingType=Paypal&systemTransactionId=1ed768bb-e88a-4636-91ae-67927ccbb02b'

Responses

Successful response

Bodyapplication/json

merchantTransactionIdstring or null, <= 50 characters

A unique transaction reference assigned by you, the merchant, to identify individual transactions. This identifier serves as a primary means of communication regarding the transaction status between you and PXP. It is essential to maintain uniqueness for each transaction, ensuring accurate tracking and communication throughout the transaction lifecycle. On create responses it is always present. On query responses it may be null for some flows (for example certain CVU deposits) when no merchant reference was supplied.

Example:"This_is_my_merchant_transaction_id"

systemTransactionIdstring, [ 36 .. 40 ] characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

A unique identifier generated by PXP for each transaction. It serves as a reference for tracking and querying transactions within the PXP system. This ID is crucial for performing modifications or querying transaction details.

Example:"1ed768bb-e88a-4636-91ae-67927ccbb02b"

providerTransactionIdstring

A unique identifier assigned by the financial service provider for the transaction. It facilitates tracking, reconciliation, and support processes.

fundingDataobject

Provider-specific order funding details (e.g., PayPal shipping and payment source fields). The exact shape depends on the fundingType.

Response

{
  "merchantTransactionId": "This_is_my_merchant_transaction_id",
  "systemTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b",
  "providerTransactionId": "string",
  "fundingData": {}
}