latestOpenAPI 3.1.02026-08-183894205.8 MB
f67a043e3190
Payout methods
List payout methods
Returns a list of active payout methods configured for a company, ordered by most recently created.
Required permissions:
- payout:destination:read
get/payout_methods
Query parameters
afterstring
Returns the elements in the list that come after the specified cursor.
beforestring
Returns the elements in the list that come before the specified cursor.
firstinteger
Returns the first n elements from the list.
Example:42
lastinteger
Returns the last n elements from the list.
Example:42
company_idstring required
The unique identifier of the company to list payout methods for.
Example:biz_xxxxxxxxxxxxxx
Response
A successful response
Example response
{
"data": [
{
"account_reference": "****1234",
"company": {
"id": "biz_xxxxxxxxxxxxxx"
},
"created_at": "2023-12-01T05:00:00.401Z",
"currency": "USD",
"id": "potk_xxxxxxxxxxxxx",
"institution_name": "Frost Bank",
"nickname": "Ops checking"
}
]
}