Terminology
| Term | Meaning |
|---|---|
| Axiym account | A balance held with Axiym and identified by accountId. |
| Address book entry | Your organization’s external bank account or wallet registered with Axiym and identified by destinationId. |
| Source account | The Axiym account that funds a withdrawal. |
| Deposit instructions | The receiving bank details or wallet address of an Axiym account, returned by GET /accounts/{accountId}/deposit-instructions. |
| Deposit | The record of an incoming payment credited to an Axiym account, identified by depositId. |
| Destination | The snapshot of the address book entry recorded on a withdrawal at creation: its destinationId and account or wallet details, without the entry's status or creation date. |
| Withdrawal | The instruction and lifecycle resource for the outgoing transfer. Creation returns it in PENDING_CONFIRMATION status. |
| Confirmation | The explicit action that moves a withdrawal from PENDING_CONFIRMATION to PENDING and begins execution. |
| External reference | Your stable reference for joining the withdrawal to your records. |
| Event | A signed notification of a resource change. |