List virtual account requests

get

https://api.sandbox.ibanq.com/v1/virtual-account-requests

Retrieves a paginated list of the virtual account requests made for every member of the caller's auth group and their active sub-accounts, optionally filtered to a single client via clientId and by status.

Query Params

clientId

string | null

Optional; when present must name a client the caller may act for and scopes the results to the requests made for that client

status

string | null

enum

Filter by status: Accepted, Allocated, Failed, Pending, Rejected

Allowed:

pageNumber

int32

1-based page number (default 1, max 100000)

pageSize

int32

Page size, 1-200 (default 50)

orderBy

string

enum

Sort key: createdAt (default createdAt)

Allowed:

orderDirection

string

enum

Sort direction: asc, desc (default desc)

Allowed:

Headers

DPoP

string

required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Paginated list of virtual account requests

400Invalid request parameters

403clientId does not match a client this credential may act for

500Internal server error

504The request timed out before a response could be produced.