> ## 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. # Create + authorize a scheduled payout > Validates the cadence (MONTHLY day-of-month 1–28, optional) and the per-run USD cap (defaults to $50k, rejected above the $250k admin ceiling), sanctions-screens every recipient in the payload, verifies the transaction PIN on the dashboard path (api-key exempt), stamps authorizedAt/By, and computes the first nextRunAt. Unattended runs execute without re-authorization, bounded by maxRunAmountUsd. ## OpenAPI ````yaml /openapi.json post /api/v1/business/payouts/schedules 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/schedules: post: tags: - Payout Schedules summary: Create + authorize a scheduled payout description: >- Validates the cadence (MONTHLY day-of-month 1–28, optional) and the per-run USD cap (defaults to $50k, rejected above the $250k admin ceiling), sanctions-screens every recipient in the payload, verifies the transaction PIN on the dashboard path (api-key exempt), stamps authorizedAt/By, and computes the first nextRunAt. Unattended runs execute without re-authorization, bounded by maxRunAmountUsd. operationId: SchedulePayoutsController_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: $ref: '#/components/schemas/CreateScheduleDto' responses: '200': description: OK content: application/json: schema: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/ScheduleResponseDto' required: - success - data '201': description: '' content: application/json: schema: $ref: '#/components/schemas/ScheduleResponseDto' '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: CreateScheduleDto: type: object properties: name: type: string minLength: 1 maxLength: 120 description: Human label, e.g. "Monthly payroll". cadence: type: string enum: - ONCE - WEEKLY - BIWEEKLY - MONTHLY description: ONCE | WEEKLY | BIWEEKLY | MONTHLY. dayOfMonth: type: number minimum: 1 maximum: 28 description: >- MONTHLY only: day-of-month (1–28) to fire on. Absent → the creation day-of-month. Ignored for other cadences. payloadKind: type: string enum: - SINGLE - BATCH description: SINGLE | BATCH. payload: description: The frozen payout spec. allOf: - $ref: '#/components/schemas/SchedulePayloadDto' maxRunAmountUsd: type: number minimum: 0 example: 50000 description: >- Per-run USD cap (compliance). Defaults to SCHEDULE_RUN_USD_DEFAULT ($50k); rejected if above the SCHEDULE_RUN_USD_CEILING admin cap ($250k). endAt: type: string description: >- Optional natural end. After this instant the schedule auto-completes. pin: type: string minLength: 4 maxLength: 6 description: >- Transaction PIN, required on the dashboard path to authorize the schedule (verified server-side). Not required on the api-key path. Future runs execute automatically. metadata: type: object description: Optional caller metadata persisted on the schedule. maxRunLocalCaps: maxItems: 20 description: >- Optional per-currency caps for locally-denominated runs. A currency listed here is checked against the run total in that currency and is immune to FX movement; every other currency still falls under maxRunAmountUsd. Omit for USD-only capping (the existing behaviour). type: array items: $ref: '#/components/schemas/ScheduleLocalCapDto' required: - name - cadence - payloadKind - payload ScheduleResponseDto: type: object properties: id: type: string businessId: type: string name: type: string description: Human label, e.g. "Monthly payroll". cadence: type: string enum: - ONCE - WEEKLY - BIWEEKLY - MONTHLY dayOfMonth: type: number nullable: true description: MONTHLY day-of-month (1–28). Null for other cadences. payloadKind: type: string enum: - SINGLE - BATCH status: type: string enum: - ACTIVE - PAUSED - COMPLETED - CANCELLED itemCount: type: number description: Number of payout specs in the frozen payload. nextRunAt: type: string description: When the next run fires (ISO-8601). lastRunAt: type: string nullable: true description: When the last run fired (ISO-8601). endAt: type: string nullable: true description: Optional natural end (ISO-8601). runCount: type: number description: How many times this schedule has run. maxRunAmountUsd: type: string description: Per-run USD cap (compliance). maxRunLocalCaps: nullable: true description: >- Per-currency run caps, or null for USD-only capping. A currency listed here is checked against the run total in that currency, so it does not breach on FX movement alone. type: array items: $ref: '#/components/schemas/ScheduleLocalCapDto' authorizedAt: type: string description: When PIN + screening were completed at creation (ISO-8601). createdAt: type: string updatedAt: type: string required: - id - businessId - name - cadence - payloadKind - status - itemCount - nextRunAt - runCount - maxRunAmountUsd - authorizedAt - createdAt - updatedAt HttpErrorEnvelopeDto: type: object properties: success: type: boolean example: false error: $ref: '#/components/schemas/HttpErrorBodyDto' required: - success - error SchedulePayloadDto: type: object properties: kind: type: string enum: - SINGLE - BATCH description: SINGLE | BATCH discriminator. items: minItems: 1 maxItems: 5000 description: >- Payout specs. SINGLE must carry exactly one item; BATCH carries up to BATCH_MAX_ITEMS. type: array items: $ref: '#/components/schemas/ScheduleItemSpecDto' required: - kind - items ScheduleLocalCapDto: type: object properties: currency: type: string minLength: 3 maxLength: 8 example: NGN description: Destination currency this cap applies to. amount: type: string pattern: /^[0-9]+(\.[0-9]{1,8})?$/ example: '20000000' description: >- Maximum total destination amount per run in `currency`. Compared against the sum of the run's destination amounts in that currency — never converted, so it does not move with FX. required: - currency - amount 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 ScheduleItemSpecDto: type: object properties: recipientId: type: string description: >- Saved recipient id. Provide exactly one of recipientId or inline `recipient`. recipient: description: >- Inline recipient details (mutually exclusive with recipientId). Sanctions-screened and saved to your recipient book at schedule creation. allOf: - $ref: '#/components/schemas/CreateRecipientDto' 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 3166-1 alpha-2 corridor country (must match the recipient country). currency: type: string description: Local destination currency for the corridor (e.g. NGN, KES). srcAmount: type: string pattern: /^[0-9]+(\.[0-9]{1,8})?$/ example: '50.00' description: >- Source amount in USDC (the principal to convert/deliver). Provide srcAmount OR dstAmount. dstAmount: type: string pattern: /^[0-9]+(\.[0-9]{1,8})?$/ example: '50000' description: >- Destination amount in the local currency. Provide srcAmount OR dstAmount. reference: type: string minLength: 0 maxLength: 140 description: Free-form per-item reference (e.g. "March salary"). required: - country - currency 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 securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````