Payouts

List all purposes

Retrieves a list of purposes.

get/open-api/v3/purposes

Request

  • Base URL
    https://api-sandbox.interlace.money
  • URL
    https://api-sandbox.interlace.money/open-api/v3/purposes
  • Auth
    API key in header x-access-token

Query parameters

accountIdstring required

The UUID of the account.

payeeIdstring required

Beneficiary ID

balanceIdstring required

A source of funds.

Response

OK

codestring

Error code

messagestring

Error message

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.