> ## 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.

# Get a cross-currency payout quote (60s lock)

> Returns a signed quote token valid for 60 seconds. Pass the token to POST /v1/business/payouts within the window to lock the rate.



## OpenAPI

````yaml /openapi.json post /api/v1/business/payouts/quote
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/quote:
    post:
      tags:
        - Payouts
      summary: Get a cross-currency payout quote (60s lock)
      description: >-
        Returns a signed quote token valid for 60 seconds. Pass the token to
        POST /v1/business/payouts within the window to lock the rate.
      operationId: BusinessPayoutsController_quote
      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:
              $ref: '#/components/schemas/QuoteRequestDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/QuoteResponseDto'
                required:
                  - success
                  - data
        '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'
        '410':
          description: Quote expired or invalid
          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'
        '503':
          description: FX rate unavailable for corridor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
      security:
        - bearer: []
components:
  schemas:
    QuoteRequestDto:
      type: object
      properties:
        rail:
          enum:
            - LOCAL_BANK
            - LOCAL_MOMO
          type: string
        country:
          type: string
          enum:
            - NG
            - KE
            - ZA
            - TZ
            - UG
            - RW
            - MW
            - ZM
            - BW
            - CM
            - BJ
            - BF
            - CD
            - CI
            - GA
            - ML
            - CG
            - SN
            - TG
          description: ISO-2 destination country
        currency:
          type: string
          enum:
            - NGN
            - KES
            - ZAR
            - TZS
            - UGX
            - RWF
            - MWK
            - ZMW
            - BWP
            - XAF
            - XOF
            - CDF
          description: Local currency code
        srcCurrency:
          type: string
          enum:
            - USDC
          default: USDC
          description: Source wallet currency — only USDC supported in v1
        srcAmount:
          type: string
          pattern: /^\d+(\.\d+)?$/
          description: Decimal string in USDC (e.g. "100.00") — XOR with dstAmount
        dstAmount:
          type: string
          pattern: /^\d+(\.\d+)?$/
          description: >-
            Decimal string in local currency (e.g. "150000") — XOR with
            srcAmount
      required:
        - rail
        - country
        - currency
        - srcCurrency
    QuoteResponseDto:
      type: object
      properties:
        quoteToken:
          type: string
          description: Signed quote token — pass to POST /v1/business/payouts within 60s
        srcAmount:
          type: string
          description: >-
            Principal in USDC — the amount converted and delivered to the
            recipient. The fee is charged ON TOP (see totalDebit).
        dstAmount:
          type: string
          description: Local-currency amount the recipient receives
        rate:
          type: string
          description: FX rate (srcCurrency per 1 unit of dstCurrency, decimal string)
        axraFee:
          type: string
          description: Axra platform fee in USDC (== platformFee), charged on top
        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 wallet = srcAmount + networkFee
            + platformFee
        expiresAt:
          type: string
          description: ISO timestamp — token rejected if used after this
        rail:
          type: string
        country:
          type: string
        currency:
          type: string
        limits:
          description: >-
            Amount bounds for this corridor, in the same units as `dstAmount`.
            Absent when no bounds could be determined — treat that as "unknown",
            never as "no payouts allowed".
          allOf:
            - $ref: '#/components/schemas/PayoutAmountLimitsDto'
      required:
        - quoteToken
        - srcAmount
        - dstAmount
        - rate
        - axraFee
        - networkFee
        - platformFee
        - totalFee
        - totalDebit
        - expiresAt
        - rail
        - country
        - currency
    HttpErrorEnvelopeDto:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          $ref: '#/components/schemas/HttpErrorBodyDto'
      required:
        - success
        - error
    PayoutAmountLimitsDto:
      type: object
      properties:
        minAmount:
          type: number
          description: Smallest payable amount in local major units. 0 = no minimum.
        maxAmount:
          type: number
          description: Largest payable amount in local major units. 0 = no maximum.
        currency:
          type: string
          description: Currency the bounds are denominated in
      required:
        - minAmount
        - maxAmount
        - currency
    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
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````