Access Setup
Access setup is completed before an organization can call the Account API. It covers approval, access to your Axiym accounts, address book entry setup, credentials, network requirements, and webhook delivery.
What Axiym provides
For each environment, Axiym provides:
- the Account API base URL;
- OAuth
client_id,client_secret, and scope; - confirmation of accessible accounts;
- confirmation of available address book entries and their status;
- confirmation that withdrawal webhook events are enabled;
- agreed sandbox account, address book entry, withdrawal, and webhook test data.
Sandbox and production are separate environments. Each environment has its own base URL, credentials, webhook subscriptions, and data.
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox | https://partner-api.sandbox.axiym.io/api/v1 |
| Production | https://partner-api.axiym.io/api/v1 |
Network access
Confirm any egress allowlisting, inbound firewall, or other network requirements with Axiym for the relevant environment. Webhook delivery is configured through the API after access is provisioned.
Before development
- Onboarding and API approval requirements are confirmed.
- Sandbox base URL and OAuth credentials have been issued.
- Sandbox accounts and address book entries with the required status are available.
- Withdrawal webhook events are agreed.
- Credentials are stored securely.
Before production
- Production API approval is complete.
- Production base URL and OAuth credentials have been issued.
- Production accounts and address book entries with the required status are confirmed.
- Webhook receiver, signature verification, and retry handling have been tested.
- Withdrawal creation, confirmation, and reconciliation behavior have been tested in sandbox.
After onboarding, continue with the Quick Start Guide.