Get a list of bank accounts

get

https://api.sandbox.audd.digital/bank-accounts

Returns a paginated list of the bank accounts visible to you, newest first. Accounts your company owns are included, along with any shared with you. Accounts deleted with DELETE /bank-accounts/{id} are not listed.

Expect to see accounts you did not create. One is added automatically for each party that sends funds to your virtual accounts, with subType REMITTER.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

index

string

Zero-based index of the page to return.

direction

string

Sort direction. Any other value is rejected.

query

string

Free-text search, case-insensitive and matching anywhere in the value. Covers the account id, bsb, accountNumber, swiftCode, iban, payId, reference, currency and nickname, the owning company's id and name, and accountHolderName, accountHolderFirstname and accountHolderLastname. An empty value matches everything.

limit

string

Number of items returned per page. A value below 1 is rejected with a 500.

sortBy

string

Attribute to sort by, given as the underlying record's field name rather than the response field name. Verified values: dateCreated, nickname, status, subType. Note the mismatch: the creation timestamp is returned as createdAt but must be sorted as dateCreated, and sorting by createdAt is rejected. An unrecognised field is rejected with a 500.

Headers

Authorization

string

required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses

400

Invalid input. Returned when a query parameter cannot be parsed, for example a direction other than ASC or DESC, or a non-numeric limit or index. The body is the standard error shape with a message naming the parameter that failed to convert.

401

Unauthorized. The bearer token is missing, expired or invalid.

403

Forbidden. The token lacks the role needed to read bank accounts.

404

Not found

500

Internal server error. Also returned for a limit below 1 or an unrecognised sortBy field.

200Success