Fetch Payment

1 curl https://api.yoco.com/v1/payments/payment_id \ 2 -H "Authorization: Bearer <token>"

1 { 2 "amount_excl_tip": { 3 "amount": 25000, 4 "currency": "ZAR" 5 }, 6 "created_at": "2024-11-19T15:27:02+00:00", 7 "currency": "ZAR", 8 "display_name": "Payment receipt #491352", 9 "id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b", 10 "note": "This is a note on this payment.", 11 "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d", 12 "payment_method": "card", 13 "payment_source": "payment_link", 14 "processing_fees": [ 15 { 16 "amount": { 17 "amount": 1, 18 "currency": "string" 19 }, 20 "type": "initial" 21 } 22 ], 23 "receipt_number": "491352", 24 "refunded_amount": { 25 "amount": 0, 26 "currency": "ZAR" 27 }, 28 "refunds": [ 29 { 30 "created_at": "2024-11-19T15:27:02+00:00", 31 "currency": "ZAR", 32 "display_name": "Refund receipt #491352", 33 "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3", 34 "note": "This is a note on this refund.", 35 "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d", 36 "order_number": "10542623", 37 "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b", 38 "payment_method": "card", 39 "processed_at": "2024-11-20T16:27:23+00:00", 40 "processing_fees": [ 41 { 42 "amount": { 43 "amount": 27800, 44 "currency": "ZAR" 45 }, 46 "type": "initial" 47 } 48 ], 49 "receipt_number": "491352", 50 "refund_type": "auth_reversal", 51 "refunded_processing_fees": [ 52 { 53 "amount": { 54 "amount": 27800, 55 "currency": "ZAR" 56 }, 57 "type": "initial" 58 } 59 ], 60 "status": "approved", 61 "total_amount": { 62 "amount": 4500, 63 "currency": "ZAR" 64 }, 65 "updated_at": "2024-11-19T16:27:23+00:00" 66 } 67 ], 68 "status": "approved", 69 "tip_amount": { 70 "amount": 2500, 71 "currency": "ZAR" 72 }, 73 "total_amount": { 74 "amount": 27500, 75 "currency": "ZAR" 76 }, 77 "updated_at": "2024-11-19T16:27:23+00:00" 78 }

Fetch a payment

Required OAuth 2.0 scope: business/orders:read

Path parameters

payment_idstringRequired>=1 character<=100 characters

The unique identifier of the payment.

Response

Successful Response

amount_excl_tipobject

The payment amount excluding the amount designated towards the tip.

created_atstringformat: "date-time"

The payment creation date and time in ISO 8601 format.

currencystring

The currency code in ISO 4217 format.

display_namestring

A human-friendly label for the payment.

idstring

The unique identifier of the payment.

notestring or null

An optional note attached to the payment.

order_idstring or null

A reference to the original order.

payment_methodenum

The method used to make the payment.

Allowed values:

payment_sourceenum

The source of the payment.

processing_feeslist of objects

The transaction fees that have been charged against the payment.

receipt_numberstring

The receipt number of the payment.

refunded_amountobject

The amount of this payment that has been refunded, if any.

refundslist of objects

The refunds that have been issued against the payment.

statusenum

The current state of the payment.

Allowed values:

tip_amountobject

The payment amount designated towards the tip.

total_amountobject

The total payment amount.

updated_atstring or nullformat: "date-time"

The date and time the payment was last modified in ISO 8601 format.

Path parameters

Headers

Response

Errors