> ## Documentation Index > Fetch the complete documentation index at: https://docs.kirafin.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a payout > Read one payout, with who sent it, who received it, and what happened to it. `events` is the trail: one entry each time the payout changed state. ## OpenAPI ````yaml /openapi/kira-api.2026-04-14.json get /v1/payouts/{payout_id} openapi: 3.1.0 info: title: Kira API version: '2026-04-14' description: >- REST API for users, KYC/KYB verification, virtual accounts, payouts, recipients, and webhooks. Every request requires an `x-api-key` header and a bearer access token (see Authentication). Pin your account to version `2026-04-14` before integrating. contact: name: Kira API Support email: support@kirafin.ai servers: - url: https://api.balampay.com description: Production - url: https://api.balampay.com/sandbox description: Sandbox security: - bearerAuth: [] apiKeyAuth: [] tags: - name: Authentication - name: Versioning - name: Users - name: Virtual Accounts - name: Recipients - name: Quotations - name: Payouts - name: Reference paths: /v1/payouts/{payout_id}: get: tags: - Payouts summary: Get a payout description: >- Read one payout, with who sent it, who received it, and what happened to it. `events` is the trail: one entry each time the payout changed state. operationId: get_v1-payouts-payout-id parameters: - in: path name: payout_id required: true schema: type: string format: uuid description: UUID of the payout to read. - in: header name: X-Api-Version required: false description: >- Version applied to this request. It wins over your account's pinned version — see [Versioning](/using-the-api/versioning). schema: type: string example: '2026-04-14' responses: '200': description: Success. content: application/json: schema: $ref: '#/components/schemas/PayoutDetailResponse' example: payout_id: 99999999-aaaa-bbbb-cccc-dddddddddddd user_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee recipient_id: cccccccc-dddd-eeee-ffff-000000000000 quote_id: null reference: INV-2026-0042 memo: September invoice origin: payout from_amount: '1000.00' from_currency: USD to_amount: '986.50' to_currency: USD payment_method: wire txn_hash: null uetr: 20260901MMQFMP3K000123 reference_number: 20260901MMQFMP3K000123 provider_reference: act-7781 status: COMPLETED extra_info: memo: September invoice invoice_number: INV-2026-0042 metadata: {} sender: name: Alice Smith company_name: Northwind Trading LLC country: USA bank_name: Example Bank National Association bank_account: '****0001' recipient: name: null company_name: Acme Supplies LLC country: US bank_name: Example Bank National Association bank_account: '****0001' events: - event_id: 11111111-1111-1111-1111-111111111111 status: CREATED created_at: '2026-09-01T12:00:00.000Z' - event_id: 22222222-2222-2222-2222-222222222222 status: PROCESSING created_at: '2026-09-01T12:00:05.000Z' - event_id: 33333333-3333-3333-3333-333333333333 status: COMPLETED message: Funds delivered created_at: '2026-09-01T18:22:41.000Z' created_at: '2026-09-01T12:00:00.000Z' updated_at: '2026-09-01T18:22:41.000Z' '401': description: >- Your credentials could not be read. The message talks about routing, but the cause is one of these: - The `Authorization` header is missing. - The token is not a token, or was not issued for your account. - The `x-api-key` header is missing or wrong. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: invalid_request message: >- The request could not be matched to a valid route, or was malformed. Verify the path and HTTP method against the API reference. This is a routing or request error, not a credentials or signature problem. '403': description: >- The payout exists but belongs to another account holder. Unlike the other reads, this one says so rather than answering `404`. content: application/json: schema: type: object properties: statusCode: type: integer description: Repeats the HTTP status. error: type: string description: Always `Forbidden`. message: type: string description: What went wrong, in one sentence. timestamp: type: string description: When the call was rejected, as an ISO 8601 timestamp. path: type: string description: The path you called. code: type: string description: A short machine-readable reason. details: type: object additionalProperties: true description: The values involved. example: statusCode: 403 error: Forbidden message: Access denied to this payout timestamp: '2026-09-01T12:00:00.000Z' path: /v1/payouts/99999999-aaaa-bbbb-cccc-dddddddddddd code: PAYOUT_ACCESS_DENIED details: payout_id: 99999999-aaaa-bbbb-cccc-dddddddddddd '404': description: No payout has that id. content: application/json: schema: type: object properties: statusCode: type: integer description: Repeats the HTTP status. error: type: string description: Always `Not Found`. message: type: string description: What went wrong, in one sentence. timestamp: type: string description: When the call was rejected, as an ISO 8601 timestamp. path: type: string description: The path you called. code: type: string description: A short machine-readable reason. details: type: object additionalProperties: true description: The values involved. example: statusCode: 404 error: Not Found message: Payout not found timestamp: '2026-09-01T12:00:00.000Z' path: /v1/payouts/99999999-aaaa-bbbb-cccc-dddddddddddd code: PAYOUT_NOT_FOUND details: payout_id: 99999999-aaaa-bbbb-cccc-dddddddddddd security: - bearerAuth: [] apiKeyAuth: [] servers: - url: https://api.balampay.com/sandbox description: Sandbox - url: https://api.balampay.com description: Production components: schemas: PayoutDetailResponse: type: object description: One payout, in full. A field that was never set is returned as `null`. properties: payout_id: type: string format: uuid description: Payout UUID. user_id: type: string format: uuid description: The user the payout belongs to. recipient_id: type: string format: uuid description: Who was paid. quote_id: type: - string - 'null' description: The quote redeemed on this payout, when one was. reference: type: - string - 'null' description: The reference you set. memo: type: - string - 'null' description: The memo you set. origin: type: string description: >- What started it. Available options: `deposit`, `payout`, `api`. See [Payout values](/reference/payouts/values#payout-origin). from_amount: type: string description: What left the account, as a decimal string. from_currency: type: string description: Currency of `from_amount`. to_amount: type: string description: What the recipient got, as a decimal string. to_currency: type: - string - 'null' description: Currency of `to_amount`. payment_method: type: - string - 'null' description: >- Which rail it went out on, in lower case. See [Payout values](/reference/payouts/values#payout-payment_method). txn_hash: type: - string - 'null' description: On-chain transaction that settled it. `null` on a bank payout. uetr: type: - string - 'null' description: The wire's end-to-end reference, when the rail assigns one. reference_number: type: - string - 'null' description: >- The rail's own reference for the transfer. Falls back to `uetr` when there is no other. provider_reference: type: - string - 'null' description: >- The bank's own id for the transfer, for when you have to ask them about it. status: type: string description: >- Where the payout has got to. See [Payout values](/reference/payouts/values#payout-status). extra_info: type: - object - 'null' additionalProperties: true description: The notes you sent on the payout, echoed back. metadata: type: object additionalProperties: true description: Key/value pairs you attached. `{}` when you attached none. sender: type: object description: Who sent it. properties: name: type: - string - 'null' description: Full name, joined from the names on record. company_name: type: string description: Registered company name. country: type: string description: Country on the address, as an ISO 3166-1 code. bank_name: type: string description: Name of the bank. bank_account: type: string description: Account number, masked by the bank. recipient: type: object description: Who received it. properties: name: type: - string - 'null' description: Full name, joined from the names on record. company_name: type: string description: Registered company name. country: type: string description: Country on the address, as an ISO 3166-1 code. bank_name: type: string description: Name of the bank. bank_account: type: string description: Account number, masked by the bank. events: type: array description: What happened, oldest first. One entry per state the payout reached. items: type: object properties: event_id: type: string format: uuid description: Event UUID. status: type: string description: >- The state the payout reached. See [Payout values](/reference/payouts/values#payout-status). message: type: string description: >- What happened, when there is anything to add. Absent otherwise. created_at: type: string description: When it happened, as an ISO 8601 timestamp. created_at: type: string description: When the payout was created, as an ISO 8601 timestamp. updated_at: type: string description: When it last changed, as an ISO 8601 timestamp. quotation: type: object additionalProperties: true description: >- The quote this payout settled at. Only when a `quote_id` was redeemed. ErrorResponse: type: object properties: message: type: string code: type: string statusCode: type: number error: type: string timestamp: type: string path: type: string details: {} required: - message securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- The `data.access_token` value from [Get access token](/api-reference/authentication/get-access-token). apiKeyAuth: type: apiKey in: header name: x-api-key description: API key issued by Kira. ````