> ## 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 payout from an end-user wallet ## OpenAPI ````yaml /openapi.json post /api/v1/treasury/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/treasury/payouts: post: tags: - Treasury — Payouts summary: Initiate a payout from an end-user wallet operationId: TreasuryPayoutsController_create parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePayoutDto' responses: '201': description: Payout created content: application/json: schema: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/TreasuryPayoutResponseDto' 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' '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: CreatePayoutDto: type: object properties: partnerEndUserId: type: string minLength: 8 description: Partner end-user id (cuid) partnerWalletId: type: string minLength: 8 description: Source PartnerWallet id amount: type: string pattern: /^\d+(\.\d+)?$/ example: '100.00' description: Principal amount to send (wallet currency) destinationType: type: string enum: - bank_account - crypto - mobile_money destination: type: object description: Destination details (validated in service by destinationType) additionalProperties: true idempotencyKey: type: string description: Optional idempotency key (logged in metadata only in v1) metadata: type: object description: 'Test mode metadata (sandbox partners). Supported keys: test_outcome' additionalProperties: true required: - partnerEndUserId - partnerWalletId - amount - destinationType - destination TreasuryPayoutResponseDto: type: object properties: id: type: string partnerId: type: string partnerEndUserId: type: string partnerWalletId: type: string nullable: true amount: type: string example: '100.00' currency: type: string example: USDC destinationType: type: string destinationDetails: type: object additionalProperties: true status: type: string enum: - PENDING - PROCESSING - COMPLETED - FAILED - CANCELLED failureReason: type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - partnerId - partnerEndUserId - amount - currency - destinationType - destinationDetails - status - createdAt - updatedAt HttpErrorEnvelopeDto: type: object properties: success: type: boolean example: false error: $ref: '#/components/schemas/HttpErrorBodyDto' required: - success - error 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 ````