Applies to: Payouts API | OAuth API
Learn how to filter payouts by location ID, status, and time range and sort them in ascending or descending order.
The ListPayouts endpoint provides a list of payouts for a location. If you don't specify a location, the main or default location is used. To call this endpoint, set PAYOUTS_READ for the OAuth scope.
The ListPayouts endpoint supports pagination and a limit field that your application can use to indicate the page size (the number of items to return in the response). The default and maximum page size is 100 items. For more information, see Pagination.
List payouts
The following is an example response:
{ "payouts": [ { "id": "po_d001cb2c-82cd-11ec-b8a4-02420a140004", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2022-01-31T19:41:41Z", "updated_at": "2022-01-31T19:41:41Z", "amount_money": { "amount": -88, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2022-02-02", "end_to_end_id": "L2100000006" }, { "id": "po_989fdac5-7fa9-11ec-b8a4-02420a140004", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2022-01-27T19:44:53Z", "updated_at": "2022-01-27T19:44:53Z", "amount_money": { "amount": 3997, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2022-01-28", "end_to_end_id": "L2100000005" }, { "id": "po_eb4dd46f-29f9-11ec-aaa1-02420a140004", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-10-10T18:43:11Z", "updated_at": "2021-10-10T18:43:11Z", "amount_money": { "amount": 229, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000004" }, { "id": "po_3cd4afed-f878-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-08-08T18:41:27Z", "updated_at": "2021-08-08T18:41:27Z", "amount_money": { "amount": 26, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000003" }, { "id": "po_dd5909a2-ee44-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-26T19:08:30Z", "updated_at": "2021-07-26T19:08:30Z", "amount_money": { "amount": 239, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000002" }, { "id": "po_dd590570-ee44-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-26T19:08:30Z", "updated_at": "2021-07-26T19:08:30Z", "amount_money": { "amount": 91, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000001" }, { "id": "po_070431e4-e351-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-12T20:37:51Z", "updated_at": "2022-03-27T20:37:51Z", "amount_money": { "amount": 457, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2021-07-13", "end_to_end_id": "L2100000000" } ] }
To see payouts for a specific location, specify the location ID:
List payouts
The following is an example response:
{ "payouts": [ { "id": "po_d001cb2c-82cd-11ec-b8a4-02420a140004", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2022-01-31T19:41:41Z", "updated_at": "2022-01-31T19:41:41Z", "amount_money": { "amount": -88, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2022-02-02", "end_to_end_id": "L2100000006" }, { "id": "po_989fdac5-7fa9-11ec-b8a4-02420a140004", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2022-01-27T19:44:53Z", "updated_at": "2022-01-27T19:44:53Z", "amount_money": { "amount": 3997, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2022-01-28", "end_to_end_id": "L2100000005" }, { "id": "po_eb4dd46f-29f9-11ec-aaa1-02420a140004", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-10-10T18:43:11Z", "updated_at": "2021-10-10T18:43:11Z", "amount_money": { "amount": 229, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000004" }, { "id": "po_3cd4afed-f878-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-08-08T18:41:27Z", "updated_at": "2021-08-08T18:41:27Z", "amount_money": { "amount": 26, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000003" }, { "id": "po_dd5909a2-ee44-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-26T19:08:30Z", "updated_at": "2021-07-26T19:08:30Z", "amount_money": { "amount": 239, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000002" }, { "id": "po_dd590570-ee44-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-26T19:08:30Z", "updated_at": "2021-07-26T19:08:30Z", "amount_money": { "amount": 91, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000001" }, { "id": "po_070431e4-e351-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-12T20:37:51Z", "updated_at": "2022-03-27T20:37:51Z", "amount_money": { "amount": 457, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2021-07-13", "end_to_end_id": "L2100000000" } ] }
By default, results are returned from oldest to newest (or Z to A) in descending order. To switch to ascending order, set sort_order to ASC. For more details, see SortOrder.
To see payouts in a specific time range, specify the dates in the following format (see Working with Dates):
List payouts
The following is an example response:
{ "payouts": [ { "id": "po_dd590570-ee44-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-26T19:08:30Z", "updated_at": "2021-07-26T19:08:30Z", "amount_money": { "amount": 91, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000000" }, { "id": "po_dd5909a2-ee44-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-26T19:08:30Z", "updated_at": "2021-07-26T19:08:30Z", "amount_money": { "amount": 239, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "end_to_end_id": "L2100000001" }, { "id": "po_070431e4-e351-11eb-a8bb-02420a140009", "status": "SENT", "location_id": "{LOCATION_ID}", "created_at": "2021-07-12T20:37:51Z", "updated_at": "2022-03-27T20:37:51Z", "amount_money": { "amount": 457, "currency_code": "EUR" }, "destination": { "type": "BANK_ACCOUNT", "id": "bact:cgvL1yv43VFjexample" }, "version": 1, "type": "BATCH", "arrival_date": "2021-07-13", "end_to_end_id": "L2100000002" } ] }