Get a payment

GET

Retrieve a payment by its ID.

Path parameters

idstringRequired
ID of payment to retrieve.

Response

This endpoint returns an object.
idstringOptional

The unique payment ID.

You can use this ID to retrieve the payment details, or perform downstream operations.

datedatetimeOptional
The date and time at which the payment was created in UTC format.
dateUpdateddatetimeOptional
The date and time of the last payment update in UTC format.
statusenumOptional

See the payment status table for more information.

cardTokenTypeenumOptional
Allowed values: CARD_PANNETWORK_TOKENPROCESSOR_TOKEN

The type of card token used for the payment.

Only applies for card payments.

orderIdstringOptional
Your reference for the payment.
currencyCodeenumOptional

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

amountintegerOptional
The amount you charged the customer, in minor units.
orderobjectOptional
More information associated with the order.
customerIdstringOptional
The unique identifier for your customer.
customerobjectOptional
More information associated with the customer.
metadatamap from strings to anyOptional
Additional data to be used throughout the payment lifecycle.
paymentMethodobjectOptional
The payment method options provided in the request, as well as the token used to process the payment.
processorobjectOptional
More information associated with the payment processor, including the processor name.
requiredActionobjectOptional
Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance.
statusReasonobjectOptional

Check this field for more information regarding the payment’s status. This is especially useful when the status is DECLINED or FAILED.

transactionslist of objectsOptional

A list summarizing the transactions that occurred while processing the payment.

Note: a refund is a separate transaction and so will appear in this transactions list if a refund was performed.

riskDataobjectOptional
Risk data associated with this payment.

Errors

Built with