GoCardless API API Documentation
List All Payout Items
GET {{url}}/payout_items?payout={{payout}}
Returns a cursor-paginated list of items in the payout.
Body
PARAM
| Key | Datatype | Required | Description |
payout
|
string | required Unique identifier, beginning with “PO”. | |
after
|
null | Cursor pointing to the start of the desired set. | |
before
|
string | Cursor pointing to the end of the desired set. | |
include_2020_tax_cutover
|
null | Boolean value indicating whether the API should return tax data for the cutover period of April to August 2020. Defaults to false. | |
limit
|
null | Number of records to return. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"payout_items": [
{
"type": "payment_paid_out",
"amount": "10000.0",
"taxes": [],
"links": {
"payment": "PM00AGFDJYSEEQ"
}
},
{
"type": "payment_paid_out",
"amount": "1000.0",
"taxes": [],
"links": {
"payment": "PM00AGJHPN1WA0"
}
},
{
"type": "payment_paid_out",
"amount": "100000.0",
"taxes": [],
"links": {
"payment": "PM00AGJHPMTFWD"
}
}
],
"meta": {
"cursors": {
"before": null,
"after": null
},
"limit": 50
}
} |
Curl
curl -X GET 'https://api-sandbox.gocardless.com/payout_items?payout=https://api-sandbox.gocardless.com?payout=payout&after=&before= &include_2020_tax_cutover=&limit='
ENDPOINTS