Add a bank account
Registers an external bank account in the selected client's address book for whitelisting.
The entry starts in PENDING_REVIEW while Axiym performs due diligence and compliance checks. Once approved, its status becomes ACTIVE and it can fund deposits and receive withdrawals. The destination.activated webhook reports activation.
Authorization
Default In: header
Path Parameters
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.
uuidHeader Parameters
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.
uuidA unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.
length <= 255Request Body
application/json
Registers an external bank account for whitelisting in the selected client's address book. The entry starts in PENDING_REVIEW while Axiym performs due diligence and compliance checks. It can fund deposits and receive withdrawals once ACTIVE. Supply exactly one of iban and accountNumber.
Currency associated with the external bank account.
IBAN of the account. Supply it instead of accountNumber when the account has an IBAN; the check digits are verified.
^[A-Z]{2}[0-9]{2}[A-Z0-9]{10,30}$Domestic bank account number. Supply it instead of iban when the account has no IBAN.
Destination bank details.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json