> ## Documentation Index > Fetch the complete documentation index at: https://docs.infinityapp.in/llms.txt > Use this file to discover all available pages before exploring further. # Cancel a payout on hold > Cancels a payout that's `awaiting_payee` or `awaiting_funds`, and frees its reserved money. Once a payout is `pending` it can't be canceled. ## OpenAPI ````yaml /api-reference/openapi.yaml post /payouts/{id}/cancel openapi: 3.1.0 info: title: Infinity API version: v1 description: > Send cross-border payouts from your USD balance to payees' bank accounts. - **Hosts:** `https://sandbox-api.infinityapp.in/v1` for testing and `https://api.infinityapp.in/v1` for live money. - **Auth:** `Authorization: Bearer sk_test_…` on the sandbox, `sk_live_…` on live. - **JSON:** field names are snake_case. Amounts are decimal strings (`"500.00"`), currency codes are lowercase ISO 4217 (`"eur"`), countries are uppercase ISO 3166 alpha-2 (`"NL"`), and timestamps are ISO 8601 in UTC. - **Fixed shapes:** every documented response field is always present. It's `null` when there's no value, and `metadata` is `{}` when empty. - **Strict input:** an unknown field or query parameter gets a `400 unknown_parameter`, and a number where a string is expected gets a `400 type_mismatch`. - **Lists:** `limit` (1–100, default 20) and `starting_after` (the last id you saw). Responses are `{ "data": [...], "has_more": true }`, newest first. - **Idempotency:** the `Idempotency-Key` header is required on money-moving creates and optional on the others. The same key with the same body within 24 hours returns the original response. - **Request ID:** every response has a `Request-Id` header. Quote it to support. - **Rate limits:** 20 requests per second per key, with bursts up to 40. Over that gets a `429` with `Retry-After`. - **Versioning:** `/v1` only grows. New fields, endpoints, enum values, event types and error codes can be added at any time, so ignore what you don't recognise. servers: - url: https://sandbox-api.infinityapp.in/v1 description: Sandbox (sk_test_ keys) - url: https://api.infinityapp.in/v1 description: Live (sk_live_ keys) security: - apiKey: [] tags: - name: Account description: Your account profile and settings. - name: Wallets description: >- Funds held for you, one wallet per currency. Every payout names the wallet that pays for it. - name: Funding addresses description: Bank details you send money to, to fund your balance. - name: Deposits description: Money credited to your balance. - name: Currencies description: The currencies we support and which ones you can pay out in. - name: Exchange rates description: Indicative rates. A quote is the price. - name: Payees description: The people and businesses you pay. - name: Payee addresses description: >- A payee's bank account, sent by you instead of the payee filling in our hosted form. - name: Bank requirements description: The fields each currency and rail needs. - name: Quotes description: Price payouts before you send them. Nothing is saved. - name: Payouts description: Create 1 to 100 payouts in one call, then track, update or cancel them. - name: Batches description: The set of payouts created by one Create payouts call. - name: Webhook endpoints description: URLs we notify when something changes. - name: Events description: Every change from the last 30 days, to catch up on missed webhooks. paths: /payouts/{id}/cancel: post: tags: - Payouts summary: Cancel a payout on hold description: >- Cancels a payout that's `awaiting_payee` or `awaiting_funds`, and frees its reserved money. Once a payout is `pending` it can't be canceled. operationId: cancelPayout parameters: - $ref: '#/components/parameters/PayoutId' responses: '200': description: The payout with `status` `canceled`. content: application/json: schema: $ref: '#/components/schemas/Payout' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: '`payout_not_found`.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: '`payout_not_editable`: the payout isn''t held.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/RateLimited' 5XX: $ref: '#/components/responses/ServerError' components: parameters: PayoutId: name: id in: path required: true schema: type: string example: payout_4kz9xq7m2w8dn3ra schemas: Payout: type: object required: - id - batch_id - wallet_id - payee_id - amount - currency - debit_amount - debit_currency - fee - fee_bearer - rate - payee_amount - payee_currency - status - failure_code - failure_message - hold_expires_at - description - reference - metadata - created_at - updated_at properties: id: type: string example: payout_4kz9xq7m2w8dn3ra batch_id: type: string example: batch_fcb4cuwtd6fcbmwr wallet_id: type: string description: The wallet that paid. example: wallet_7t4m9k2qx8d3hn5r payee_id: type: string example: payee_c8pnahcrxqzd3z8d amount: type: string description: What you entered. example: '500.00' currency: type: string description: The currency of `amount`. `usd` on INR accounts. example: eur debit_amount: type: - string - 'null' description: What left your balance, fee included. example: '568.35' debit_currency: type: string description: The currency of the paying wallet. example: usd fee: type: - string - 'null' description: In `debit_currency`. example: '10.00' fee_bearer: type: string enum: - account - payee rate: type: - string - 'null' description: >- From `debit_currency` to `payee_currency`. `null` until it's known (INR before settlement). example: '0.8955' payee_amount: type: - string - 'null' description: >- What the payee receives. An estimate until `paid`, then the actual. On INR payouts it's `null` until `paid`. example: '500.00' payee_currency: type: string example: eur status: $ref: '#/components/schemas/PayoutStatus' failure_code: $ref: '#/components/schemas/FailureCode' failure_message: type: - string - 'null' description: A fixed sentence for each `failure_code`. example: null hold_expires_at: type: - string - 'null' format: date-time description: Set if the payout was ever held. example: null description: type: - string - 'null' description: Shared by every payout in a batch. example: October invoice reference: type: - string - 'null' example: inv-1042 metadata: $ref: '#/components/schemas/Metadata' created_at: type: string format: date-time example: '2026-10-26T10:05:00Z' updated_at: type: string format: date-time example: '2026-10-26T10:05:00Z' ErrorResponse: type: object required: - error properties: error: type: object required: - type - code - message - param - request_id - timestamp properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - rate_limit_error - api_error description: The class of error, from the HTTP status. code: type: string description: >- What went wrong. Branch on this. New codes can be added, so handle an unknown one by its HTTP status. example: invalid_payout_request message: type: string description: For a developer to read. It can change, so never parse it. example: amount has more than 2 decimals for eur. param: type: - string - 'null' description: >- The field at fault, with its path: `amount`, `items[3].payee_id`, `beneficiary_address.postal_code` or `Idempotency-Key`. example: amount request_id: type: string description: The same as the `Request-Id` header. example: req_4f4b2bjc4mamxuxm timestamp: type: string format: date-time example: '2026-10-29T10:00:00Z' PayoutStatus: type: string description: > - `awaiting_payee`: money reserved, waiting for the payee to finish onboarding. - `awaiting_funds`: the payee is ready, but the balance was too low at release. - `pending`: created and handed to the payout network. - `processing`: accepted and on its way. - `paid`: delivered. - `failed`: not delivered; `failure_code` says why. - `returned`: delivered, then sent back by the payee's bank. - `canceled`: canceled by you while held. - `expired`: the hold ran out before the payee was ready. enum: - awaiting_payee - awaiting_funds - pending - processing - paid - failed - returned - canceled - expired example: pending FailureCode: type: - string - 'null' description: Why a payout `failed` or was `returned`. New codes can be added. enum: - below_minimum - insufficient_funds - bank_account_missing - bank_details_invalid - rate_changed - returned_by_bank - undeliverable - refunded - refund_failed - canceled - processing_error - null example: null Metadata: type: object description: >- Up to 20 key-value pairs of your own. Keys up to 40 characters, values up to 500, strings only. maxProperties: 20 additionalProperties: type: string maxLength: 500 example: invoice: inv-1042 responses: Unauthorized: description: >- `missing_authorization`, `invalid_api_key` (no such key, or it's revoked), `wrong_environment` (a test key on live, or a live key on the sandbox). headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error code: wrong_environment message: This is a live key. Use it on api.infinityapp.in. param: null request_id: req_4f4b2bjc4mamxuxm timestamp: '2026-10-29T10:00:00Z' Forbidden: description: '`account_inactive`: the account behind this key isn''t active.' headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' RateLimited: description: >- `rate_limited`: over 20 requests per second for this key. Wait for `Retry-After` and try again. headers: Retry-After: $ref: '#/components/headers/RetryAfter' Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' ServerError: description: >- `internal_server_error` (500, our fault) or `service_unavailable` (503, something we depend on is down). Safe to retry with the same `Idempotency-Key`. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: RequestId: description: This call's id. Quote it to support. schema: type: string example: req_4f4b2bjc4mamxuxm RetryAfter: description: Seconds to wait before retrying. schema: type: integer example: 1 securitySchemes: apiKey: type: http scheme: bearer description: > Your secret key: `sk_test_…` on the sandbox host, `sk_live_…` on live. A key on the wrong host gets a `401 wrong_environment`. Keys are secret. Keep them on your server, never in a browser or app. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.