Build the payout payload

A payout request combines the funding account and the fixed amount with the businesses, the destination bank account, the purpose, and the evidence needed to execute the payment. Axiym calculates the commercial terms when the payout is created.

Anatomy of a payout request

Funding, amount, and reference

sourceAccountId selects the funding account. Exactly one of sourceAmount (fixed debit) or destinationAmount (fixed delivery) sets the amount, while externalReference identifies the payout in your own system.

Sender

The business making the payment, whether your organization or a client, including its registered details, contact information, identification, related individuals, and the documents that evidence them. Omit it when you pay for yourself.

Recipient

The business receiving the funds, its relationship to the sender, its documents where required, and the bank account that receives the destination currency.

Payment fields

Where the funds came from (sourceOfFunds), why the payment is being made (purpose), the text the recipient sees (reference), and the payment evidence (supportingDocuments).

This is a structural illustration, not a complete request. See the complete payout example for full party objects. Replace the document placeholder with encoded file content.

{
  "sourceAccountId": "5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e",
  "destinationAmount": { "amount": "56500.00", "currency": "PHP" },
  "externalReference": "PAYOUT-2026-001",
  "sourceOfFunds": "BUSINESS_INCOME",
  "purpose": "GOODS_PURCHASE",
  "reference": "INV-2026-0917",
  "supportingDocuments": [
    {
      "documentType": "INVOICE",
      "name": "INV-2026-0917.pdf",
      "data": "REPLACE_WITH_BASE64_ENCODED_INVOICE"
    }
  ],
  "sender": "<Axiym or partner shape>",
  "recipient": "<Axiym or partner shape>"
}

Amounts are Money objects in both directions: { "amount": "56500.00", "currency": "PHP" }. Use sourceAmount in the funding account's currency to fix what is debited, or destinationAmount in the destination currency to fix what is delivered.

When using custom field names or value labels, include paymentDataMapId and submit to POST /payouts/mapped. Each party uses Axiym field structure when its map section is empty, or the stored field mappings when present. Use POST /payouts without a map when all fields and codes already follow Axiym's contract.

Explore the sender and related individuals, recipient and bank account, source of funds, purpose, and documents, and supporting documents individually for their complete field requirements.

Validation and review

The API reference defines the baseline request structure. Corridor details add the applicable required fields, formats, and bank-routing rules. Use the Country Playbook to explore those destination requirements.

Create the payout once the required data is ready. Axiym validates the payment details and returns the prepared instruction and commercial terms in PENDING_CONFIRMATION. Review these before confirming. Confirmation reserves funds and starts processing.