Get transaction details

Retrieve data about a specific transaction.

Get a transaction's details

GET

/v1/transactions/{merchant}/{site}

Looks up a transaction by identifier. Provide at least one of merchantTransactionId or systemTransactionId. This endpoint isn't a list or search API.

Request examples

To get a transaction's details, supply the merchant and site associated with the transaction, and either its merchantTransactionId or its systemTransactionId.

curl --request GET \
     --url 'https://api-services.pxp.io/api/v1/transactions/MERCHANT-1/SITE-1?merchantTransactionId=ECOM-001' \
     --header 'accept: application/json'

Path parameters

Parameter	Description
`merchant` string (≤ 20 characters) required	The unique merchant identifier associated with this transaction, as assigned by PXP.
`site` string (≤ 50 characters) required	The unique site identifier associated with this transaction, as assigned by PXP.

Query parameters

Provide at least one of the following identifiers.

Parameter	Description
`merchantTransactionId` string (≤ 50 characters)	The unique identifier that you assigned to this transaction. Required for lookup unless `systemTransactionId` is provided.
`systemTransactionId` string (36 characters)	The unique identifier assigned to this transaction by PXP. Required for lookup unless `merchantTransactionId` is provided.

Response examples

If your request is successful, you'll receive a 200 response containing a JSON array with zero or one transaction object:

[] when no matching transaction is found.
A single-element array when a match is found.

[
  {
    "systemTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b",
    "state": "Authorised",
    "stateData": {
      "code": "CRD000",
      "message": "Approved"
    },
    "transactionMethod": {
      "intent": "Authorisation",
      "fundingType": "Card",
      "entryType": "Ecom"
    },
    "approvalCode": "123456",
    "merchant": "MERCHANT-1",
    "site": "SITE-1",
    "merchantTransactionId": "ECOM-001",
    "merchantTransactionDate": "2024-01-27T08:51:02.826Z",
    "fundingData": {
      "maskedPrimaryAccountNumber": "************1234",
      "cardScheme": "Visa",
      "expiryMonth": "12",
      "expiryYear": "2025",
      "gatewayTokenIdBase32": "GA4TSMZVGE3DKMRVGQZTCMBYGE",
      "providerResponse": {
        "provider": "pxpfinancial",
        "code": "00",
        "message": "Transaction Approved"
      }
    }
  }
]

Response properties

Each item in the array is a transaction object. Key fields include:

Property	Description
`systemTransactionId` string	The unique identifier assigned to this transaction by PXP.
`merchantTransactionId` string	The unique identifier that you assigned to this transaction.
`merchantTransactionDate` date-time	The date and time when the transaction was initiated, in ISO 8601 format.
`merchant` string	The merchant identifier associated with this transaction.
`site` string	The site identifier associated with this transaction.
`state` string (enum)	The current state of the transaction. Learn more about states.
`stateData` object	A response code and message describing the transaction outcome. Learn more about state data.
`stateData.code` string	The state details code (for example, `CRD000`).
`stateData.message` string	The state details message (for example, `Approved`).
`transactionMethod` object	Details about the transaction method, including `intent`, `fundingType`, and `entryType`.
`approvalCode` string	The approval code returned by the authorising entity, when applicable.
`providerTransactionId` string	The unique identifier assigned by the financial service provider for the transaction, when returned.
`entryType` string (enum)	For in-store transactions, the method by which the card was presented (for example, `ChipAndPin`, `CardContactless`). Returned at the root of the transaction object.
`fundingData` object	Details about the payment method used for the transaction, including card scheme, masked PAN, token IDs, and verification results.
`fundingData.gatewayTokenId` string	A securely stored token for the payment card, when returned.
`fundingData.gatewayTokenIdBase32` string	The Base32-encoded representation of the gateway token ID, when returned.
`fundingData.providerResponse` object	Raw data received from the payment provider. Learn more about the provider response.