Skip to navigation
CollectPaymentsManage Payments

Retrieve Payment Status (Transaction)

Retrieves status/details of a transaction by transactionId.

Path parameters

transactionIdstringRequiredformat: "uuid"
Unique identifier for the transaction.

Response

Transaction status retrieved successfully.
statusstring
Current transaction status.
transactionIdstring
Unique identifier for the transaction.
messagestring

Human-readable status message.

authStateobjectOptional

Detail for the transaction's current state. When the transaction status is AUTH_REQUIRED, authMethodType says how the payer completes authentication, and a matching detail object (redirect, fields, ussd, bankTransfer) carries the specifics. Error states instead carry code, message, and the raw connectorFailureCode/connectorFailureMessage.

sessionIdstringOptionalformat: "uuid"
Session the transaction belongs to.
merchantReferencestringOptional
Merchant reference from the original session.
processorNamestringOptional

Name of the payment processor (if assigned).

processorReferencestringOptional

Processor reference (if available).

paymentMethodIdstringOptional

The payment method used, e.g. card or mobilemoney.

identifiersmap from strings to stringsOptional

Additional identifiers, usually sessionId and payerId.

paymentAttributesmap from strings to stringsOptional
Attributes associated with the payment.
batchPayoutIdstringOptional
Batch payout identifier, present when the transaction is part of a batch payout.
collectionobjectOptional

Amount the customer paid in the collection currency. Present only on transactions converted by Adaptive Currency Conversion — per-session rate or rate lock.

fxMidRatestringOptional

Spot mid-market rate at the time the FX quote was committed for this attempt (decimal string, 8 decimal places). Present only on FX-converted transactions.

fxAllInRatestringOptional

Mid rate + markup — the rate this attempt was actually converted at (decimal string, 8 decimal places). Present only on FX-converted transactions.

fxMarkupBpsintegerOptional>=0

Markup applied to this attempt in basis points (100 bps = 1%). Present only on FX-converted transactions.

fxFeeobjectOptional

Conversion fee, denominated in the collection currency. Present only on FX-converted transactions.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error