List bank accounts

get

https://test-api.payology.io/org-bank/api/v1/bank-account

List configured organization bank accounts. Pagination is zero-based (page=0). type=X9 filters to enabled check accounts. Account numbers are masked for ordinary partner access.

This request has no JSON body. Use the path/query examples below.

Request examples

X9Accounts

GET /org-bank/api/v1/bank-account?type=X9&status=Active&page=0&limit=25 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

Result codes in the response examples

HTTP status and result code are operation-specific. Field-validation messages can include the affected field name.

HTTP	Code	Result	Meaning
400	R0002	Error	Field is not properly formatted
400	R0129	Error	Field type is not properly formatted. Valid types are: ACH, PAD, X9
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 0

Defaults to 0

Zero-based page index.

limit

integer

≥ 1

Defaults to 12

Requested maximum number of records on a page.

order_by

string

Sort field. Default: created_at.

order

string

enum

Sort direction: asc or desc.

Allowed:

name

string

Display name of the organization bank account.

token

string

Filter by organization bank account token.

account_number

string

Bank or card account number. Request fields contain the supplied account; response fields are masked.

bank_token

string

Filter by the bank institution UUID, not the organization bank account UUID.

type

string

enum

Payment-method selector. Use X9 for payments and ACH/CC for profiles as specified on the operation.

Allowed:

permission_type

string

enum

Filter by the bank account EFT permission: Debit, Credit or Both.

Allowed:

status

string

enum

Lifecycle or processing status of the surrounding resource. Allowed values depend on the operation.

Allowed:

org_token

string

Filter to the organization identified by this UUID.

Responses

default

Other infrastructure or forwarded downstream response. HTTP status and body must be preserved; do not assume every error has a Payology R-code. No fixed payload is guaranteed.

200Paginated bank accounts. No matches returns an empty data array.

400Invalid fields, selector, or business rule. Consult the individual example code.

401Authentication failed. Some services also use 401 for organization access denial. Gateway bodies can differ.

403Permission or organization access denied; the gateway can reject the request before it reaches the service.

429Gateway throttling or quota. Exact quota, retry headers and deployed body were not verified. This is a platform possibility, not an observed Payology response.

500Unhandled service failure. Gateway configuration/authorizer failures can also return 500.

504Gateway integration timeout or failure. The service may still have committed a create request. This is a platform possibility, not an observed Payology response.