clipboard-questionQuery Transaction

⚠️ Important Notes

  • Pending, Processing, Completed, Failed

    These are the possible status values returned by the query endpoint. Only completed is considered a successful terminal state.

  • You need to keep our response. This is what will be used to query the transaction

    When you initiate a payout, you receive a unique transaction reference. Store it — it's required for querying status later.

Retrieve transaction

get
Path parameters
idstringRequired

The transaction ID

Example: 4a162406-5320-474b-9462-c11a52416f73
Responses
chevron-right
200

Transaction information retrieved successfully.

application/json
idintegerOptional

The transaction ID

Example: 2
referencestringOptional

Unique reference for the transaction

Example: 49434b7a-9b79-44ab-b1fd-a7d5c93dcd91
currency_codestringOptional

The currency code

Example: GBP
amountstringOptional

The amount of the transaction

Example: 100
chargesstringOptional

The charges for the transaction

Example: 0
statusstringOptional

The status of the transaction

Example: Processing
narrationstringOptional

A description or reason for the transaction

Example: Test Payout
typestringOptional

The type of the transaction

Example: Debit
merchant_referencestringOptional

The merchant's reference for the transaction

Example: sdkfjsldfj
get
/v1/payment/transaction/{id}
200

Transaction information retrieved successfully.

Last updated