Faster Payments

List all payees

Returns a paginated list of Payee records created against the authenticated company. Payees are scoped to the Company (not MID). By default, the 25 most recently created Payees are returned.

get/payees

Request

Base URL
https://test-api.acquired.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquired/apis/acquired-api/docs/payees/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

account_namestring

Filter by exact or partial account name.

account_numberstring

Example:23234334

Filter by exact account number.

sort_codestring

Example:010203

Filter by exact sort code.

is_activeboolean

Example:true

Filter by active status

Headers

Company-Idstring uuid required

Unique ID assigned by Acquired.com for your company. If not set, the default company context is used.

Response

Changes

No recorded changes to this operation across all 2 revisions of this API.