Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Payments

Get Payment

Fetch a single payment

get/payments/v1/{payment_id}

Path parameters

payment_idstring required

Response

idstring uuid required

The unique identifier for this payment.

payment_intent_idstring uuid required

The Payment Intent identifier responsible for generating the Payment.

payment_source_idstring uuid required

The identifier for the payment source object from which the payment was initiatied.

amountnumber required

The amount the charge was initiated for.

currencystring required

The currency the payment was initiated with.

descriptionstring required

The description submitted to the bank as a reference when initiating a payment. Can be used for reconciliation. By default this value is a the Payment Intent UUID without hyphens but you can also specify the description upon creation of a payment intent.

submission_timestampstring required

The time the Payment Initiation was submitted.

initiation_timestampstring required

The time the Payment Initiation was started.

status'AWAITING_LOGIN_MFA' | 'AWAITING_PAYMENT_MFA' | 'AWAITING_APP_AUTH' | 'FAILED' | 'PENDING_WITH_BANK' | 'ACCEPTED_BY_BANK' required

The current status of the payment - see Payments Errors for a list of available MFAs.

bank_transaction_referencestring required

The transaction reference number supplied by the initiating bank on successful initiation of a transfer. Can be used for reconciliation.