> ## Documentation Index > Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt > Use this file to discover all available pages before exploring further. # Initiate a business payout > Confirms a payout against a signed `quoteToken` (LOCAL_BANK / LOCAL_MOMO). Name the destination in exactly one of three ways: `recipientId` for a recipient saved via POST /v1/business/payouts/recipients; inline `recipient` to send the details on the payout itself; or, for requests authenticated with `x-api-key`, inline `destination`. The quote is scoped to corridor, amount and business — never to a recipient — so one token confirms any of the three. Screening differs by channel: dashboard (JWT) payouts are sanctions-screened and a saved recipient carrying a match is refused; `x-api-key` payouts are not screened by Axra (the merchant is the obligated party under the merchant agreement) and an inline recipient/destination is paid ad hoc rather than saved, so the payout returns recipientId null. Server-to-server payouts are also exempt from the interactive 2FA gate — the controls are the secret key and the per-corridor velocity caps. ## OpenAPI ````yaml /openapi.json post /api/v1/business/payouts openapi: 3.0.0 info: title: Axra Public API description: Merchant and third-party developer API surface version: '2026-04-15' contact: {} servers: - url: http://localhost:3001 description: Local development - url: https://staging-api.useaxra.com description: Staging - url: https://api.useaxra.com description: Production security: [] tags: - name: Authentication description: >- Exchange your API credentials for a short-lived bearer token, rotate a leaked key, and confirm which account a credential belongs to. Start here — every other operation on this page requires one of these credentials. - name: Payments description: >- Accept card payments server-to-server, or hand the customer a hosted checkout session, then complete 3-D Secure, retrieve, list and refund what you charged. Also exposes the fee schedule that applies to your own account. - name: Payment Links description: >- Shareable hosted payment pages. Create a link, send it to a customer and let us host the checkout, instead of building a payment page of your own. - name: Local Rails description: >- Collect from customers over local bank transfer and mobile money in supported markets. List the channels available for a country, currency and amount, then create a collection and poll it for the funds. - name: Elements description: >- Browser-side card tokenisation for the drop-in payment SDK. Your page exchanges card details for a single-use token, so raw card numbers never reach your server. - name: Customers description: >- Customers you have charged and the payment methods saved against them, so a returning buyer can pay without re-entering their card. - name: Payouts description: >- Send money out to a bank account or mobile money wallet. Quote a cross-currency payout before you commit to it, look up the destination networks for a corridor, then track or cancel what you sent. - name: Payout Recipients description: >- Saved payout destinations. Store a beneficiary once and reference it by id on later payouts, instead of resending full account details every time. - name: Payout Batches description: >- Pay many recipients in one submission — payroll and mass disbursement. A batch is created as a priced draft you can inspect, and only moves money once you submit it. - name: Payout Schedules description: >- Payouts that run later, once or on a repeating cadence. Authorize the schedule up front, then pause, resume, edit or cancel it. - name: Disputes description: >- Chargebacks raised against your payments. Review them, upload evidence to contest one, accept the loss, and set the defence policy applied on your behalf. - name: Fraud description: >- Your own fraud rules, evaluated on payments before they are charged, plus the block list those rules produce. Test a rule against a sample payload before enabling it. - name: Treasury — End-Users description: >- Banking-as-a-Service. The end-users your platform holds balances for — create one before provisioning a wallet or starting identity verification. - name: Treasury — KYC description: >- Identity verification for a treasury end-user: start a check and read its status. Sandbox-only helpers drive a pending check to approved or rejected so you can build against both outcomes. - name: Treasury — Wallets description: >- Currency-scoped balances held for an end-user. Provision a wallet, read its ledger balance and entries, and fetch the instructions a customer uses to fund it. - name: Treasury — Payouts description: >- Move money out of an end-user wallet, then track or cancel it while it is still pending. - name: Webhooks description: >- Register endpoints to receive signed event callbacks, inspect delivery attempts, replay a delivery and rotate a signing secret. The two products keep separate registries: `/webhook-endpoints` for the merchant API, `/treasury/webhook-endpoints` for treasury partners. paths: /api/v1/business/payouts: post: tags: - Payouts summary: Initiate a business payout description: >- Confirms a payout against a signed `quoteToken` (LOCAL_BANK / LOCAL_MOMO). Name the destination in exactly one of three ways: `recipientId` for a recipient saved via POST /v1/business/payouts/recipients; inline `recipient` to send the details on the payout itself; or, for requests authenticated with `x-api-key`, inline `destination`. The quote is scoped to corridor, amount and business — never to a recipient — so one token confirms any of the three. Screening differs by channel: dashboard (JWT) payouts are sanctions-screened and a saved recipient carrying a match is refused; `x-api-key` payouts are not screened by Axra (the merchant is the obligated party under the merchant agreement) and an inline recipient/destination is paid ad hoc rather than saved, so the payout returns recipientId null. Server-to-server payouts are also exempt from the interactive 2FA gate — the controls are the secret key and the per-corridor velocity caps. operationId: BusinessPayoutsController_create parameters: - name: X-Axra-Business-Id in: header description: Active business context required: false schema: type: string - name: x-api-key in: header description: Merchant API key (alternative to dashboard JWT) required: false schema: type: string requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/BusinessCreatePayoutDto' - $ref: '#/components/schemas/CreateLocalBankPayoutDto' - $ref: '#/components/schemas/CreateLocalMomoPayoutDto' responses: '200': description: OK content: application/json: schema: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/BusinessPayoutResponseDto' required: - success - data '201': description: '' content: application/json: schema: $ref: '#/components/schemas/BusinessPayoutResponseDto' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '422': description: Unprocessable content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/HttpErrorEnvelopeDto' security: - bearer: [] components: schemas: BusinessCreatePayoutDto: type: object properties: rail: type: string enum: - CRYPTO - ACH - WIRE - SEPA - SWIFT - LOCAL_BANK - LOCAL_MOMO recipientId: type: string description: >- Saved recipient id. For LOCAL_BANK / LOCAL_MOMO provide exactly one of recipientId, inline `recipient`, or (api-key only) inline `destination`. On other rails it is mutually exclusive with `destination`. recipient: description: >- Inline recipient details for LOCAL_BANK / LOCAL_MOMO (mutually exclusive with recipientId). Paid in the same call — a single quote→pay round-trip. Behaviour depends on how the request is authenticated: on the DASHBOARD (JWT) the recipient is sanctions-screened, account-resolved and saved to your recipient book; on the MERCHANT API (`x-api-key`) it is treated as an ad-hoc destination — not screened by Axra and not saved, so the payout comes back with recipientId null and cannot be reused by id. Use POST /v1/business/payouts/recipients first if you want a reusable recipientId. allOf: - $ref: '#/components/schemas/CreateRecipientDto' destination: type: object description: >- Ad-hoc destination, mutually exclusive with recipientId. On LOCAL_BANK / LOCAL_MOMO it is accepted only for requests authenticated with `x-api-key`; a dashboard (JWT) request must use recipientId or inline `recipient`. Same fields as the rail's recipient `details` object. Nothing is persisted to your recipient book, so the payout has recipientId null. quoteToken: type: string description: >- Signed quote token from POST /v1/business/payouts/quote (required for LOCAL_BANK / LOCAL_MOMO) amount: type: string pattern: /^[0-9]+(\.[0-9]{1,8})?$/ example: '50.00' description: >- Decimal string (up to 8 fractional digits). Ignored for LOCAL_* rails — amounts come from quoteToken. currency: type: string enum: - USDC - EURC - GBPC - NGN description: >- Ignored for LOCAL_* rails — wallet debit currency is USDC from the quote. twoFactorCode: type: string minLength: 6 maxLength: 6 description: Fresh TOTP code when amount >= $10k USD-equivalent idempotencyKey: type: string minLength: 8 maxLength: 64 metadata: type: object required: - rail - idempotencyKey CreateLocalBankPayoutDto: type: object properties: rail: type: string enum: - LOCAL_BANK quoteToken: type: string description: Signed quote token from POST /v1/business/payouts/quote recipientId: type: string description: >- Saved recipient id (from POST /v1/business/payouts/recipients). Provide this OR inline `recipient`, not both. recipient: description: >- Inline recipient details (mutually exclusive with recipientId) — a single quote→pay round-trip. On the DASHBOARD (JWT) the recipient is created, sanctions-screened and saved to your recipient book. On the MERCHANT API (`x-api-key`) it is paid as an ad-hoc destination: not screened by Axra, not saved, and the payout returns recipientId null. Create the recipient first via POST /v1/business/payouts/recipients if you need a reusable id. allOf: - $ref: '#/components/schemas/CreateLocalBankRecipientDto' idempotencyKey: type: string minLength: 8 maxLength: 64 metadata: type: object required: - rail - quoteToken - idempotencyKey CreateLocalMomoPayoutDto: type: object properties: rail: type: string enum: - LOCAL_MOMO quoteToken: type: string description: Signed quote token from POST /v1/business/payouts/quote recipientId: type: string description: >- Saved recipient id (from POST /v1/business/payouts/recipients). Provide this OR inline `recipient`, not both. recipient: description: >- Inline recipient details (mutually exclusive with recipientId) — a single quote→pay round-trip. On the DASHBOARD (JWT) the recipient is created, sanctions-screened and saved to your recipient book. On the MERCHANT API (`x-api-key`) it is paid as an ad-hoc destination: not screened by Axra, not saved, and the payout returns recipientId null. Create the recipient first via POST /v1/business/payouts/recipients if you need a reusable id. allOf: - $ref: '#/components/schemas/CreateLocalMomoRecipientDto' idempotencyKey: type: string minLength: 8 maxLength: 64 metadata: type: object required: - rail - quoteToken - idempotencyKey BusinessPayoutResponseDto: type: object properties: id: type: string businessId: type: string rail: type: string enum: - CRYPTO - ACH - WIRE - SEPA - SWIFT - LOCAL_BANK - LOCAL_MOMO status: type: string enum: - CREATED - SUBMITTED - PENDING_REVIEW - SETTLED - FAILED - CANCELLED amount: type: string description: Principal (USDC) — the amount converted/delivered. Fee is on top. currency: type: string enum: - USDC - EURC - GBPC - NGN feeAmount: type: string description: Axra platform fee in USDC (== platformFee) networkFee: type: string description: Network (provider) cost in USDC, charged on top platformFee: type: string description: Axra platform fee in USDC, charged on top totalFee: type: string description: Total fee in USDC = networkFee + platformFee totalDebit: type: string description: >- Total USDC debited from the merchant = amount + networkFee + platformFee recipientId: type: string nullable: true destinationMasked: type: object additionalProperties: type: string providerRef: type: string nullable: true failureReason: type: string nullable: true createdAt: type: string submittedAt: type: string nullable: true settledAt: type: string nullable: true cancelledAt: type: string nullable: true quote: description: Present for LOCAL_BANK / LOCAL_MOMO payouts locked via quote token allOf: - $ref: '#/components/schemas/PayoutQuoteBreakdownDto' required: - id - businessId - rail - status - amount - currency - feeAmount - networkFee - platformFee - totalFee - totalDebit - destinationMasked - createdAt HttpErrorEnvelopeDto: type: object properties: success: type: boolean example: false error: $ref: '#/components/schemas/HttpErrorBodyDto' required: - success - error CreateRecipientDto: type: object properties: label: type: string maxLength: 120 rail: type: string enum: - CRYPTO - ACH - WIRE - SEPA - SWIFT - LOCAL_BANK - LOCAL_MOMO details: type: object description: Rail-specific destination (shape depends on rail) required: - label - rail - details CreateLocalBankRecipientDto: type: object properties: label: type: string maxLength: 120 rail: type: string enum: - LOCAL_BANK details: $ref: '#/components/schemas/LocalBankDetailsDto' required: - label - rail - details CreateLocalMomoRecipientDto: type: object properties: label: type: string maxLength: 120 rail: type: string enum: - LOCAL_MOMO details: $ref: '#/components/schemas/LocalMomoDetailsDto' required: - label - rail - details PayoutQuoteBreakdownDto: type: object properties: dstAmount: type: string rate: type: string axraFee: type: string currency: type: string country: type: string required: - dstAmount - rate - axraFee - currency - country HttpErrorBodyDto: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: email must be an email statusCode: type: number example: 400 errors: type: object description: >- Optional per-field validation messages (when present on the source exception) additionalProperties: type: array items: type: string required: - code - message - statusCode LocalBankDetailsDto: type: object properties: country: type: string enum: - NG - KE - ZA - TZ - UG - RW - MW - ZM - BW - CM - BJ - BF - CD - CI - GA - ML - CG - SN - TG accountNumber: type: string description: Plain at input; encrypted at rest accountName: type: string minLength: 2 maxLength: 120 bankCode: type: string description: Upstream bank network identifier bankName: type: string required: - country - accountNumber - accountName - bankCode - bankName LocalMomoDetailsDto: type: object properties: country: type: string enum: - NG - KE - ZA - TZ - UG - RW - MW - ZM - BW - CM - BJ - BF - CD - CI - GA - ML - CG - SN - TG phoneNumber: type: string description: E.164 phone number including + and country code accountName: type: string minLength: 2 maxLength: 120 networkId: type: string description: Upstream mobile-money network identifier networkName: type: string required: - country - phoneNumber - accountName - networkId - networkName securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````