--- title: "Cancel payout" method: POST path: "/payouts/v3/cancel" tags: ["Manage payouts"] --- # Cancel payout `POST /payouts/v3/cancel` ## Request - Base URL: `https://api.dlocal.com` - URL: `https://api.dlocal.com/payouts/v3/cancel` - Auth: API key in header `X-Date` and API key in header `X-Version` and API key in header `Authorization` This endpoint allows you to cancel a payout. --- Note that only payouts with `PENDING` or `ON_HOLD` status can be canceled. If the request fails, refer to the [Error codes page](https://docs.dlocal.com/reference/error-codes-payouts-v3) for details. ## Request body - CancelPayoutRequest - `id` string, required: Payout identification at the dlocal's end. ## Response `200` Cancelled payout - ResponseGetPayout: The standard schema for all Payout responses (Submit, Get, Cancel, Release). - `id` string: Payout ID generated by dLocal - `external_id` string: External ID provided by the merchant - `status` string: Status of the payout (e.g., PENDING, CANCELLED) - `status_code` string: Status code of the payout - `status_detail` string: Detailed status message - `created_date` string, date-time: Creation date of the payout - `last_updated` string, date-time: Last update date of the payout - `payment_method_id` string: Payout method - `flow_type` string: Indicates payout flow - `country` string: Country code of the payout - `currency` string: Currency in which the FX conversion was based on - `currency_to_pay` string: Currency in which the payment was paid - `amount` number: Amount paid out - `purpose` string: Purpose of the payout - `statement_descriptor` string: Statement descriptor - `description` string: Payment description - `on_hold` boolean: Indicates if the payout is on hold - `notification_url` string: Notification callback URL - `amount_details` object: Details about the payout amount (present on GET endpoint) - `amount_to_pay` number: Final amount paid to the beneficiary. - `exchange` object - `source_amount` number: Amount in source currency. - `source_currency` string, ISO-4217 currency code: Source currency. - `destination_amount` number: Amount in destination currency. - `destination_currency` string, ISO-4217 currency code: Destination currency. - `exchange_rate` number: Exchange rate applied. - `fees` Fees - `amount` number: Total fees amount applicable to the transaction. - `currency` string, ISO-4217 currency code: Currency for the total processing fees. - `taxes` Taxes - `amount` number: Total tax amount applicable to the transaction. - `currency` string, ISO-4217 currency code: Currency for the total taxes applied. - `debit` Debit - `amount` number: Total amount that would be debited from the merchant's balance. - `currency` string, ISO-4217 currency code: Currency for the debit to the merchant's balance. - `beneficiary` object: Beneficiary information - `first_name` string: Beneficiary first name. - `last_name` string: Beneficiary last name. Only applies when the beneficiary is an individual. - `phone` string: Beneficiary's phone number. - `email` string: Beneficiary's email. - `bank_account` object: Beneficiary bank account information. - `code` string: Beneficiary's bank account code. - `branch` string: Beneficiary's bank account branch. - `type` string: Beneficiary's bank account type. - `account` string: Beneficiary's bank account. - `document` object: Beneficiary identification document. - `type` string: Beneficiary's document type. Possible values: PASS - Passport, DNI - National ID, RUC, or other values fixed by country. - `id` string: Beneficiary's document ID or number. - `birth_info` object: Beneficiary birth information. - `date` string: Beneficiary's birth date in ISO 8601 format (YYYY-MM-DD). - `country` string: Beneficiary's place of birth (country). ISO 3166-1 alpha-2 code. - `city` string: Beneficiary's city of birth. - `address` object: Beneficiary address information. - `street` string: Beneficiary's address street. - `number` string: Beneficiary's address street number. - `city` string: Beneficiary's address city. - `state` string: Beneficiary's address state. - `country` string: Beneficiary's address country. ISO 3166-1 alpha-2 code. - `postal_code` string: Beneficiary's address postal code. - `remitter` Remitter: Remitter information. - `first_name` string: Remitter's first name. - `last_name` string: Remitter's last name. - `nationality` string: Remitter's nationality. ISO 3166-1 alpha-2 code. - `phone` string: Remitter's phone number. - `email` string: Remitter's email. - `funds_source` string: Source of the funds for the remittance. - `document` object: Remitter identification document. - `type` string: Remitter's document type. - `id` string: Remitter's document ID or number. - `issue_date` string: Remitter's document issue date in ISO 8601 format (YYYY-MM-DD). - `expiration_date` string: Remitter's document expiration date in ISO 8601 format (YYYY-MM-DD). - `birth_info` object: Remitter birth information. - `date` string: Remitter's birth date in ISO 8601 format (YYYY-MM-DD). - `country` string: Remitter's place of birth (country). ISO 3166-1 alpha-2 code. - `city` string: Remitter's city of birth. - `address` object: Remitter address information. - `street` string: Remitter's address street. - `number` string: Remitter's address street number. - `city` string: Remitter's address city. - `state` string: Remitter's address state. - `country` string: Remitter's address country. ISO 3166-1 alpha-2 code. - `postal_code` string: Remitter's address postal code. ## Other responses - `400`: Bad Request - `403`: Forbidden --- [API](https://skmtc.dev/dlocal/apis/payouts-v3.md) - [All operations](https://skmtc.dev/dlocal/apis/payouts-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/dlocal/apis/payouts-v3/revisions/02c74e9e986e?raw)