Skip to main content

Platform endpoints — payees

How to call the payees routes. The formal schema is the OpenAPI specification (openapi/source/platform/payees/payees.yml); this page is the call contract.

All routes require a bearer token (B2B JWT) with CLIENT role and an ACTIVE party. Global /v1 prefix applies.

Route summary​

MethodPathCodePurpose
GET/v1/payees200List all payees for the party
GET/v1/payees/:payeeId200Get payee details
POST/v1/payees201Create a payee
DELETE/v1/payees/:payeeId204Delete a payee

Route details​

GET /v1/payees — list payees​

Returns all of the party's payees as a single list. If the platform cannot reach one of the backing providers, the whole request fails rather than returning a partial list. Listing (or creating) a payee makes its payeeId known to the platform, so later GET /:payeeId and DELETE /:payeeId calls resolve directly.

GET /v1/payees/:payeeId — payee detail​

Returns the payee's details. The payeeId must already be known to the platform (from a prior list or create); an unknown id returns 404 PAE004001.

Path parameter: payeeId (string, Ark payee id).

Errors:

HTTPCodeWhen
404PAE004001Payee not found (unknown payeeId, or not found at the provider)

POST /v1/payees — create payee (201)​

Creates a payee with the backing provider configured for the caller's party.

Body: PayeeCreationRequestPlatformApi — payee details (BSB, account number, PayID, or BPAY); see OAS.

Errors:

HTTPCodeWhen
400GEN000000Body fails schema validation
400PAE400001Invalid BSB
400PAE400002Invalid CRN
400PAE400003Invalid PayID format
409PAE009001Duplicate payee
422PAE422001Missing account number

DELETE /v1/payees/:payeeId — delete payee (204)​

Deletes the payee at the backing provider that holds it.

Path parameter: payeeId (string, Ark payee id).

Errors:

HTTPCodeWhen
404PAE004001Payee not found

Auth​

All routes: bearer token (B2B JWT) with CLIENT role; party must be ACTIVE.