Retrieve Payment

{
  "status": "string",
  "transactionId": "string",
  "message": "string",
  "authState": {
    "state": "string",
    "transitionedAt": "string",
    "transactionId": "string"
  },
  "merchantReference": "string",
  "sessionId": "string",
  "identifiers": {},
  "paymentAttributes": {},
  "paymentMethodId": "string",
  "processorName": "string",
  "processorReference": "string",
  "financialTransactionReference": "string",
  "currentAttemptId": "string",
  "batchPayoutId": "string",
  "collection": {
    "amount": "string",
    "currency": "string"
  },
  "fxMidRate": "string",
  "fxAllInRate": "string",
  "fxMarkupBps": 1,
  "fxFee": {
    "amount": "string",
    "currency": "string"
  }
}

Retrieves the current status and details of an existing payment transaction.

Path parameters

transactionIdstringRequired

Unique identifier for the payment transaction

Response

Payment details retrieved successfully

statusstring

Current transaction status

transactionIdstring

Unique transaction identifier

messagestring

Status message describing the transaction state

authStateobject

Authentication state union containing all possible transaction states

merchantReferencestring

Merchant reference from the original session

sessionIdstringformat: "uuid"

Session ID associated with the transaction

identifiersmap from strings to strings

Additional identifiers related to the transaction

paymentAttributesmap from strings to strings

Payment-specific attributes and metadata

paymentMethodIdstring

Payment method identifier

processorNamestring

Payment processor name

processorReferencestring

Payment processor reference

financialTransactionReferencestring

Financial transaction reference from the processor

currentAttemptIdstring

Current attempt identifier

batchPayoutIdstring

Batch payout identifier, if the transaction is part of a batch payout

collectionobject

Monetary amount as a decimal-string major unit + currency code

fxMidRatestringformat: "^\d+(\.\d+)?$"

Spot mid-market rate at the time the quote was committed (8 decimal places).

fxAllInRatestringformat: "^\d+(\.\d+)?$"

Mid rate + markup — the rate actually applied to convert source to collection (8 decimal places).

fxMarkupBpsinteger>=0

Markup applied in basis points (0–10000).

fxFeeobject

Monetary amount as a decimal-string major unit + currency code

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error