Get payout details
Last updated: April 29, 2022
Fetch and view relevant information and parameters related to a specific payout. Before you start, make sure you have the payment identifier (prefixed by pay_
). To get a detailed view of all required and optional fields, see our API reference.
Use the details below to set up your request.
get
https://api.checkout.com/payments/{id}
Header | Value |
---|---|
required |
|
required |
|
Path | Value |
---|---|
required | The payment identifier (prefixed with |
If your request is successful, the response will return information about the payout.
1{2"id": "pay_gwlowf7eap7uzm4cyaaqoq62au",3"requested_on": "2020-06-12T13:49:19.085546Z",4"source": {5"id": "ca_y3oqhf46pyzuxjbcn2giaqnb44",6"type": "currency_account"7},8"destination": {9"id": "src_4pakgjwmv5re5m5ivqohsqpxnm",10"type": "bank_account"11},12"amount": 1000,13"currency": "GBP",14"reference": "PO-215-5721",15"billing_descriptor": {16"reference": "Withdrawal"17},18"status": "Returned",19"approved": true,20"sender": {21"type": "instrument",22"reference": "8285282045818"23},24"instruction": {25"value_date": "2020-06-13T01:49:19.1864428Z",26"purpose": "Wallet withdrawal",27"quote_id": "qte_xrhaw53z5m6ehbbxz2n6n5lk74"28},29"_links": {30"self": {31"href": "https://api.sandbox.checkout.com/payments/pay_gwlowf7eap7uzm4cyaaqoq62au"32},33"actions": {34"href": "https://api.sandbox.checkout.com/payments/pay_gwlowf7eap7uzm4cyaaqoq62au/actions"35}36}37}
Information
If unsuccessful, you may get a 404 – Payment not found
error.
Find out what the different fields in your successful response mean.
Field name | Description |
---|---|
string | The unique identifier of the payout action. |
string | The date and time the payout was requested. |
object | Details about the payout source. |
string | The payment source identifier, which can be used for subsequent payments. |
string | The payment source type. This is always set to |
object | Details about destination of the payout. |
string | The payment instrument identifier. |
string | The payout destination. |
integer | The original payout amount. |
string | The three-letter ISO currency code of the payment. |
string | Your reference for the payout. |
object | Details about the billing descriptor. |
string | The reference that is displayed on the account holder's statement. |
string | The status of the payout. This can be one of:
|
boolean | Whether the authorization was successful. |
object | Details about the sender of the payout's funds. |
string | The type of sender. This can be one of:
|
string | The payout sender's unique identifier. |
object | Details about the instruction for payouts to bank accounts. Depending on the initial request, this can contain the following strings:
|
object | Links related to the payout. |
string | The direct link to the payout. |
string | The link to the list of actions related to this payout. |