mercadopago.cancellations-refunds.create-refund

Creates a full or partial refund for an approved payment. Omit the amount field for a full refund. Partial refunds are supported; multiple partials are allowed up to the original transaction amount. Idempotent: Supports X-Idempotency-Key header to safely retry without duplicate charges.

Create a refund

Overview

Property	Value
Workflow type	Atomic
Library	App-mercadopago
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Mercadopago API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
id	integer	Yes	—	Payment ID to refund
x_idempotency_key	string	No	—	—
amount	float	No	—	Amount to refund. Omit for a full refund.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Mercadopago API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
id	integer	Yes	—	Payment ID to refund
x_idempotency_key	string	No	—	—
amount	float	No	—	Amount to refund. Omit for a full refund.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /v1/payments/{id}/refunds
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /v1/payments/{id}/refunds
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "mercadopago.cancellations-refunds.create-refund",
  "initial_data": {
    "base_url": "value",
    "id": 123
  }
}