Axiym

Get an address book entry

Returns an external bank account or wallet registered in the selected client's address book, including its current status and payment details. Its address book identifier is destinationId.

An external account is whitelisted for deposits and withdrawals when its status is ACTIVE.

AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Client Account API resources. The client must belong to your partnership; anyone else's id returns 404.

Formatuuid
destinationId*string

Identifier of the external account in the selected client's address book (UUID).

Formatuuid

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json