Axiym

List address book entries

Returns registered external bank accounts and wallet addresses available as withdrawal destinations.

Only an ACTIVE entry can receive a withdrawal. Use the optional filters to narrow the result by currency or status.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Query Parameters

first?integer

Maximum number of items to return (page size).

Range1 <= value <= 100
Default20
after?string

Cursor for the next page, from the previous response's pageInfo.endCursor.

currency?string

Filter by currency.

status?string

Filter by status.

Allowed values

  • "PENDING_REVIEW"
  • "ACTIVE"
  • "SUSPENDED"
  • "CLOSED"

Header Parameters

X-Request-Id?string

Optional client-generated request identifier (UUID recommended) for end-to-end tracing.

Axiym echoes it in the X-Request-Id response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json