API ReferenceCustomersAPI IntegrationPayments

Get Payment Details

Beta

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

Authentication: Bearer token required

Path parameters

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.
client_reference_idstring

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

statusenum

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

fx_conversionobject
payoutslist of objects

Errors