Axiym

Create a payout

Creates a payout using Axiym field names and exact controlled-value codes. Non-canonical labels are rejected. To use your own field structure or value labels, store a Payment Data Map and use POST /payouts/mapped.

Axiym validates corridor availability, amount limits, and payment requirements, applies any documented deterministic formatting rules, and calculates commercial terms.

Creation returns the prepared instruction and commercial terms in PENDING_CONFIRMATION. It does not reserve funds or start processing. Review the returned document, then confirm it before termsExpireAt.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in X-Request-Id, or generates one when omitted.

Formatuuid
Idempotency-Key*string

Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.

Lengthlength <= 255

Request Body

application/json

Creates a payout from a funding account, a fixed amount on one side, and complete payment instruction. Exactly one of sourceAmount or destinationAmount must be supplied. Sender and recipient data use Axiym's field structure.

sourceAccountId*string

Axiym account debited for the payout. Available funds are checked when the payout is confirmed.

Formatuuid
sourceAmount?object

Amount to debit from the source account, in the source account currency. Supply exactly one of sourceAmount or destinationAmount.

destinationAmount?object

Amount the recipient must receive, in the destination currency. Supply exactly one of sourceAmount or destinationAmount.

sender?object

The party on whose behalf the payment is made. Omit when you pay for yourself — the account holder is then the sender and its onboarded profile is used.

recipient*RecipientInput

Recipient details using Axiym field names and exact controlled-value codes. Corridor requirements may add identification, evidence, or routing requirements.

externalReference?string

Your reference for the payout. It is returned on the payout and related webhook events, and must be unique when supplied.

sourceOfFunds?string

Origin of the funds used for this payment. Required where the corridor requires a source-of-funds code, including when sender is omitted. Use an exact Axiym code; other labels require a saved value translation on POST /payouts/mapped.

Allowed values

  • "BUSINESS_INCOME"
  • "SALE_OF_GOODS"
  • "SALE_OF_SERVICES"
  • "COMMISSION"
  • "RENTAL_INCOME"
  • "INVESTMENT_INCOME"
  • "LOAN_PROCEEDS"
  • "CAPITAL_CONTRIBUTION"
  • "SALE_OF_REAL_ESTATE"
  • "SALE_OF_OTHER_ASSETS"
  • "GRANT"
  • "DONATION"
  • "INSURANCE_PAYOUT"
purpose?string

Use an exact Axiym TransactionPurpose code. To send your own labels, store reviewed value translations in a Payment Data Map and use POST /payouts/mapped. Required where the corridor requires a purpose code.

Allowed values

  • "GOODS_PURCHASE"
  • "SERVICES_PAYMENT"
  • "SUPPLIER_PAYMENT"
  • "SALARY_PAYROLL"
  • "RENT_LEASE"
  • "LOAN_DISBURSEMENT"
  • "LOAN_REPAYMENT"
  • "INTEREST_PAYMENT"
  • "INTERCOMPANY_TRANSFER"
  • "OWN_ACCOUNT_TRANSFER"
  • "TREASURY_MANAGEMENT"
  • "TAX_PAYMENT"
  • "INVESTMENT"
  • "REAL_ESTATE_PURCHASE"
  • "INSURANCE_PAYMENT"
  • "BUSINESS_EXPENSES"
  • "EDUCATION_TRAINING_FEES"
  • "SUBSCRIPTION_MEMBERSHIP_FEES"
  • "ROYALTY_LICENSE_FEES"
  • "CHARITABLE_DONATION"
  • "REFUND"
  • "OTHER"
reference?string

Text shown to the recipient, typically the invoice number.

supportingDocuments?array<SupportingDocumentInput>

Documents supporting the payment, such as an invoice. Required where the corridor requires evidence.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json