Get Payment Details

Beta

Retrieve details for a specific payment by payment_id for a given customer.

Authentication: Bearer token required

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired
Unique identifier for the customer who owns the payment.
payment_idstringRequired
Unique identifier for the payment.

Response

Successful response with payment details
payment_idstring
Unique identifier assigned by the API when the payment is created.
instruction_numberstring
Instruction number assigned by the API when the payment is created.
statusenum

Current status of the payment. Refer to the Payment Status Events section for more details about the statuses.

payoutslist of objects
client_reference_idstring or null

Client-provided reference ID for the payment while creating the payment.

fx_conversionobject or null
FX conversion details. **Important:** This field is only present when currency conversion was performed (i.e., when `quote_id` was provided in the payment request). **Not present for same-currency payments** (when source and destination currencies are the same and no `quote_id` was provided).

Errors