# Axiym Payment API

Product: Payment API
API reference version: 0.1.0 (current)
OpenAPI contract: https://docs.axiym.io/openapi/payment-api/0.1.0.yaml
Canonical page: https://docs.axiym.io/payment-api/api-reference/0.1.0

Use the Payment API to make cross-border payments to beneficiaries, whether paying for your organization or on behalf of a client. Each outgoing payment is represented by a payout resource.

Create a payout with the funding account, amount, and complete payment instruction. Axiym returns the prepared instruction and time-limited commercial terms. Review and confirm the payout before the terms expire to reserve funds and start processing. Your credentials determine which accounts, payouts, Payment Data Maps, and webhook subscriptions your integration can access.

## Downloads




OpenAPI contract

v0.1.0 · current

Explore the schema or generate a client for your integration.

[


Download OpenAPI](/openapi/payment-api/0.1.0.yaml)




Postman collection

v0.1.0 · current

Import ready-to-use requests and connect to the sandbox.

[


Download collection](/postman/payment-api/axiym_payment_api_v0.1.0.json)

## Environments




Sandbox

[`https://partner-api.sandbox.axiym.io/api/v1`](https://partner-api.sandbox.axiym.io/api/v1)




Production

[`https://partner-api.axiym.io/api/v1`](https://partner-api.axiym.io/api/v1)

## Resources



[Auth](/payment-api/api-reference/0.1.0/auth/oauth/token/post)

OAuth 2.0 authentication for your integration.







[Accounts](/payment-api/api-reference/0.1.0/accounts/listAccounts)

Axiym accounts and balances available to fund payments.







[Corridors](/payment-api/api-reference/0.1.0/corridors/listCorridors)

Payment corridors available to your integration.







[Payouts](/payment-api/api-reference/0.1.0/payouts/listPayouts)

Create, review, confirm, and track outgoing payments.







[Payment Data Maps](/payment-api/api-reference/0.1.0/payment-data-maps/listPaymentDataMaps)

Reusable party field mappings and reviewed value translations, stored as immutable definitions for mapped payout requests.







[Webhook Subscriptions](/payment-api/api-reference/0.1.0/webhook-subscriptions/webhooks/subscriptions/get)

Webhook endpoint registration, test deliveries, and signing keys.