Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Payouts

Gets a payout by ID

Retrieves the details of a payout. Supply the unique identifier of the payout.

get/payouts/{id}

Path parameters

idstring required

Payout ID

Response

OK.

idstring

Unique identifier for the payout

createdTimestring date-time

Time at which the payout was created

payoutTimestring date-time

Time at which the payout was issued

currencystring

Three-letter ISO currency code representing the payout currency.

amountnumber double

Represents the total payout amount.

payerIdstring

The ID of payer.

payerNamestring

The name of the payer

payeeIdstring

The ID of the payee.

payeeNamestring

The name of the payee.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "id": "2000028600_1410_2019",
  "createdTime": "2019-04-25T20:36:00Z",
  "payoutTime": "2019-04-25T00:00:00Z",
  "currency": "USD",
  "amount": 1180.26,
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true
}