Axiym

Axiym Payment API

Use the Payment API to make cross-border business payments on behalf of your clients. The partner access token identifies the partnership that owns each account, quote, payment, Party Data Map, and webhook subscription. The sender and receiver are supplied in full with each payment and do not need to be onboarded as Axiym clients.

Party Data Maps and webhook subscriptions are partnership-owned resources. A Party Data Map can therefore be reused across the clients represented by the same partnership.

The public Payload Mapping Tool produces portable sender-and-receiver mapping JSON. Submit the reviewed definition through the authenticated Party Data Maps endpoints, then test it with representative payment data before creating a payment. Values that use an Axiym-controlled vocabulary are normalized for each payment before the prepared instruction is returned for confirmation.

Environments

Sandbox

https://partner-api.sandbox.axiym.io/api/v1

Production

https://partner-api.axiym.io/api/v1

Resources

Auth

OAuth 2.0 client credentials authentication for the partnership.

Accounts

Partner-owned Axiym accounts whose existing balances can fund payments.

Corridors

Payment routes available to the partnership.

Quotes

Time-limited payment quotes funded by partner-owned accounts.

Payouts

Cross-border payments made by the partner on behalf of its clients.

Party Data Maps

Partnership-owned reusable mappings for sender and receiver field paths.

Webhook Subscriptions

Partnership-owned webhook subscriptions and signing keys.

The operation pages in this section are generated from the same specification published at /openapi/payment-api/0.1.0.yaml.

On this page

EnvironmentsResources