Getting started

Read Concepts & Workflows first, then follow the steps below.

Integration tools

• Postman collection — Try requests in Sandbox. Set clientId and clientSecret, then send the Auth token request; the collection saves the token for subsequent requests.
• Integrate using AI — Documentation formats and an optional integration prompt for your coding agent.

Base URLs

Sandbox and production have separate credentials and data.

Steps

1. Get access. Obtain OAuth credentials and follow the shared authentication, headers, and idempotency rules.
2. Register webhooks before onboarding or funding, so you do not miss asynchronous changes. See Webhooks.
3. Onboard a client and wait until the onboarding case is APPROVED, then verify that the client is ACTIVE.
4. Check financing capacity for the payment's currency and rail.
5. Fund the payment and repay the receivable: request funding, follow the receivable, tell payers what to put in the memo, apply unallocated funds, return excess funds.

Fundamentals

Shared across Axiym APIs: Authentication, Common headers, Idempotency, Pagination, Errors and retries, Rate limits, Data formats, Payment rails.

Before going live

• New access tokens are obtained before expiry, without exposing credentials.
• Requests carry an X-Request-Id; funding, repayment, and transfer requests carry an Idempotency-Key.
• Funding is requested only for ACTIVE clients with enough availableBalance.
• Your payment ID, clientId, and receivableId are stored together.
• Webhook deliveries are verified and deduplicated; the resource is read for its current state.
• Disbursements, repayments, and balances are reconciled.