> ## Documentation Index > Fetch the complete documentation index at: https://docs.keette.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Payout ## OpenAPI ````yaml /openapi.yaml get /payouts/{id} openapi: 3.1.0 info: title: Keette API version: 1.0.0 description: | Public HTTP API for Keette workspaces. One base URL — live vs sandbox is selected by your API key (`sk_live_…` / `sk_test_…`). Endpoints are added as each implementation phase ships. contact: name: Keette Support email: talk@keette.com servers: - url: https://20b9-41-90-209-232.ngrok-free.app/v1 description: Local (ngrok) - url: https://api.keette.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: Identity for the authenticating API key - name: Balances description: Wallet books - name: Beneficiaries description: Payout recipients - name: Transactions description: Unified transaction index - name: FX description: Indicative rates and firm quotes - name: Catalog description: Payout corridors and relationships - name: Payouts description: Send money to a beneficiary - name: Payins description: Collect money into your books - name: Swaps description: FX between your own books - name: Events description: Durable event log for webhook polling paths: /payouts/{id}: get: tags: - Payouts summary: Get Payout operationId: getPayout parameters: - name: id in: path required: true schema: type: string format: uuid example: 6e0e15cf-8736-44fc-bb9b-372eb7b14145 responses: '200': description: Payout content: application/json: schema: $ref: '#/components/schemas/Payout' examples: queued: value: object: payout id: 6e0e15cf-8736-44fc-bb9b-372eb7b14145 status: queued currency: NGN amount: 5000000 fee: 15000 transfer_fee: 10000 scheme: ngn_bank country: NG stan: OUT-2610-ABCDEF12 beneficiary_id: bbd938a2-dbbe-43bf-bfb9-1c5dbe444523 purpose: supplier_goods purpose_label: Supplier payment for goods invoice_ref: INV-2026-042 cancellable: false created_at: '2026-10-27T13:00:00Z' updated_at: '2026-10-27T13:00:01Z' authorised_at: '2026-10-27T13:00:01Z' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/Forbidden' components: schemas: Payout: type: object required: - object - id - status - currency - amount - stan - beneficiary_id properties: object: type: string enum: - payout description: Object type discriminator. id: type: string format: uuid description: Payout id. status: type: string enum: - awaiting_auth - pending_approval - queued - sending - completed - failed - cancelled - rejected - expired description: > Lifecycle status. `pending_approval` means maker-checker is waiting on a second admin in the dashboard. `queued`/`sending` are in flight. currency: type: string description: Source book currency that was (or will be) debited. amount: type: integer description: Gross send in Ledger minor units. fee: type: integer description: Customer-visible transfer fee (partner + margin + cross-border). transfer_fee: type: integer description: >- Transfer fee component in minor units (same as `fee` for most corridors). scheme: type: string description: Corridor scheme used for the send. country: type: string description: Destination country (ISO 3166-1 alpha-2). stan: type: string description: System trace / remittance reference. beneficiary_id: type: string format: uuid description: Recipient beneficiary id. purpose: type: string description: Purpose code submitted with the payout. purpose_label: type: string description: Human-readable purpose label. note: type: string description: Free-text note from the request. invoice_ref: type: string description: Invoice or remittance reference. quote_id: type: string format: uuid description: Firm FX quote used when currencies differed. fx_rate: type: string description: Applied FX rate when cross-currency. recipient_currency: type: string description: Currency credited to the beneficiary. recipient_amount: type: integer description: Amount the beneficiary receives, in their minor units. recipient_scale: type: integer description: Decimal places for `recipient_currency`. cancellable: type: boolean description: Whether `POST /payouts/{id}/cancel` can still succeed. failure_reason: type: string description: >- Partner or validation failure message when status is `failed`/`rejected`. authorised_at: type: string format: date-time description: When the send was authorised (API key or PIN). completed_at: type: string format: date-time description: When the payout reached a terminal success state. created_at: type: string format: date-time description: Creation time (UTC). updated_at: type: string format: date-time description: Last status change (UTC). Error: type: object required: - error properties: error: type: object required: - type - code - message properties: type: type: string description: Broad error class for client handling. enum: - invalid_request - authentication_error - permission_error - rate_limit - api_error code: type: string description: Stable machine-readable code (e.g. `parameter_invalid`). message: type: string description: Human-readable explanation safe to show developers. param: type: string description: Request field that failed validation, when applicable. doc_url: type: string format: uri description: Optional link to docs for this error. responses: Unauthorized: description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: authentication_error code: invalid_api_key message: Invalid API key provided. Forbidden: description: API disabled for this tenant or globally content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: permission_error code: api_disabled message: Public API access is disabled for this workspace. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: | Secret API key from **Settings → Developers → API keys**. Example: `Authorization: Bearer sk_test_…` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.