> ## 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 scheduled payout > Returns the schedule plus a MASKED list of its recipients (`items[]`): label, rail, corridor (country · currency), and the configured per-run amount only. No account numbers / IBAN / phone and no partner names are exposed. ## OpenAPI ````yaml /openapi.json get /api/v1/business/payouts/schedules/{id} 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: [] paths: /api/v1/business/payouts/schedules/{id}: get: tags: - Business Payout Schedules summary: Get a scheduled payout description: >- Returns the schedule plus a MASKED list of its recipients (`items[]`): label, rail, corridor (country · currency), and the configured per-run amount only. No account numbers / IBAN / phone and no partner names are exposed. operationId: SchedulePayoutsController_findOne 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 - name: id required: true in: path schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/ScheduleDetailResponseDto' 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: ScheduleDetailResponseDto: 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: object 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: object nullable: true description: When the last run fired (ISO-8601). endAt: type: object 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 items: description: Masked recipient summaries. type: array items: $ref: '#/components/schemas/ScheduleItemSummaryDto' required: - id - businessId - name - cadence - payloadKind - status - itemCount - nextRunAt - runCount - maxRunAmountUsd - authorizedAt - createdAt - updatedAt - items HttpErrorEnvelopeDto: type: object properties: success: type: boolean example: false error: $ref: '#/components/schemas/HttpErrorBodyDto' required: - success - error ScheduleLocalCapDto: type: object properties: currency: type: string example: NGN description: Destination currency this cap applies to. amount: type: string 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 ScheduleItemSummaryDto: type: object properties: index: type: number description: Zero-based position of this item in the payload. recipientId: type: object nullable: true description: >- Saved-recipient id when this item references the recipient book, for web edit pre-fill. Null for inline recipients (the web treats those as re-enter-to-change). Not PII. recipientLabel: type: string description: Human recipient label (e.g. "Jane Doe"). No PII. rail: type: string description: Payout rail (e.g. LOCAL_BANK / LOCAL_MOMO). No partner name. country: type: string description: ISO 3166-1 alpha-2 corridor country. currency: type: string description: Local destination currency for the corridor. amount: type: object nullable: true description: >- DEPRECATED — collapsed per-run amount (srcAmount ?? dstAmount) kept for backwards compatibility. It does NOT say which side the figure is on, so a client that reads it and writes back cannot know whether "150000" meant 150000 USDC or ₦150,000. Read `srcAmount` / `dstAmount` instead. deprecated: true srcAmount: type: string nullable: true description: >- Configured per-run source amount in USDC, when the schedule is source-denominated. Exactly one of srcAmount / dstAmount is non-null. dstAmount: type: string nullable: true description: >- Configured per-run destination amount in the local currency, when the schedule is destination-denominated (e.g. a salary contracted in NGN). Each run re-quotes so this exact local amount is delivered and the USDC debit floats with the rate. reference: type: object nullable: true description: Optional payment reference. required: - index - recipientLabel - rail - country - 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 ````