Payouts
Search payouts by gateway_account_id and state
get/v1/payout
Query parameters
statestring
State of payout. allowed values are intransit, paidout, failed
pageinteger
Page number requested for the search, should be a positive integer (optional, defaults to 1)
display_sizeinteger
Number of results to be shown per page, should be a positive integer (optional, defaults to 500, max 500)
override_account_id_restrictionboolean
Set to true to list all payouts.
gateway_account_idstring required
Comma delimited gateway account IDs. Required except when override_account_id_restriction=true
Response
OK
Example response
{
"_links": {
"first_page": {
"href": "https://an.example.link"
},
"last_page": {
"href": "https://an.example.link"
},
"next_page": {
"href": "https://an.example.link"
},
"prev_page": {
"href": "https://an.example.link"
},
"self": {
"href": "https://an.example.link"
}
},
"count": 100,
"page": 1,
"results": [
{
"amount": 1000,
"gateway_account_id": "1",
"gateway_payout_id": "po_sd0fkpam0dlwe10dmlsl3mf",
"live": true,
"service_id": "dlsd0dkad20sk0adne9fjd",
"state": "{\"status\":\"paidout\",\"finished\":true}"
}
],
"total": 1000
}