v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Payouts

List all purposes

Retrieves a list of purposes.

get/open-api/v3/purposes

Query parameters

accountIdstring required

The UUID of the account.

The UUID of the account.

payeeIdstring required

Beneficiary ID

Beneficiary ID

balanceIdstring required

A source of funds.

A source of funds.

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter"
}