file-contractPayment Detail

Retrieve payment details

get
Path parameters
transaction_refstringRequired

Reference for the transaction.

Example: 34534redf3d00
Responses
chevron-right
200

Payment details retrieved successfully.

application/json
idintegerOptional

Unique identifier for the payment.

Example: 53
our_referencestringOptional

Internal reference for the payment.

Example: 202503131111096386ed356c98f9a4
amountstringOptional

Amount of the payment.

Example: 5.00
transaction_refstringOptional

Reference for the transaction.

Example: 34534redf3d00
currency_codestringOptional

Currency code of the payment.

Example: GBP
currency_symbolstringOptional

Currency symbol of the payment.

Example: £
narrationstringOptional

Description or reason for the payment.

Example: Gift
statusstringOptional

Status of the payment.

Example: PENDING
payer_namestringOptional

Name of the payer.

metadataobject · nullableOptional

Additional metadata for the payment.

webhook_urlstringOptional

URL for webhook notifications related to this payment.

Example: https://webhook.site/481927c8-36d7-4cc0-a9de-49562206d9b1
redirect_urlstringOptional

URL to redirect after payment.

Example: https://wikipedia.com
created_onstring · date-timeOptional

Timestamp when the payment was created.

Example: 2025-03-13T11:11:09.638493Z
institution_codestringOptional

Institution code related to the payment.

get
/payments/{transaction_ref}/

Last updated