Skip to content

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.

Endpoints

get

https://api.checkout.com/payments/{id}

Header parameters

HeaderValue

Authorization

required

Bearer {OAuth Bearer access token}

Content-Type

required

application/json

Path parameters

PathValue

id

required

The payment identifier (prefixed with pay_).

Response example

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.

Response parameters

Find out what the different fields in your successful response mean.

Field nameDescription

id

string

The unique identifier of the payout action.

requested_on

string

The date and time the payout was requested.

source

object

Details about the payout source.

source.id

string

The payment source identifier, which can be used for subsequent payments.

source.type

string

The payment source type. This is always set to currency_account for payouts.

destination

object

Details about destination of the payout.

destination.id

string

The payment instrument identifier.

destination.type

string

The payout destination.

amount

integer

The original payout amount.

currency

string

The three-letter ISO currency code of the payment.

reference

string

Your reference for the payout.

billing_descriptor

object

Details about the billing descriptor.

billing_descriptor.reference

string

The reference that is displayed on the account holder's statement.

status

string

The status of the payout.

This can be one of:

  • Pending
  • Paid
  • Declined
  • Returned

approved

boolean

Whether the authorization was successful.

sender

object

Details about the sender of the payout's funds.

sender.type

string

The type of sender.

This can be one of:

  • instrument
  • individual
  • corporate

sender.reference

string

The payout sender's unique identifier.

instruction

object

Details about the instruction for payouts to bank accounts.

Depending on the initial request, this can contain the following strings:

  • instruction.value_date
  • instruction.purpose
  • instruction.charge_bearer
  • instruction.repair
  • instruction.scheme
  • instruction.quote_id

links

object

Links related to the payout.

links.self

string

The direct link to the payout.

links.actions

string

The link to the list of actions related to this payout.