mercadopago.payments.update-payment

Update payment fields or capture an authorized payment. To capture an authorized two-step payment: send {"capture": true}. To cancel an authorized payment: send {"status": "cancelled"}.

Update or capture a payment

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	—	—
capture	boolean	No	—	Set true to capture an authorized payment.
status	string	No	—	Set to cancelled to cancel an authorized payment.
transaction_amount	float	No	—	Partial capture amount (must be ≤ original authorized amount).
date_of_expiration	string	No	—	New expiration date for cash payment methods.

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	—	—
capture	boolean	No	—	Set true to capture an authorized payment.
status	string	No	—	Set to cancelled to cancel an authorized payment.
transaction_amount	float	No	—	Partial capture amount (must be ≤ original authorized amount).
date_of_expiration	string	No	—	New expiration date for cash payment methods.
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 PUT /v1/payments/
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 PUT /v1/payments/
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "mercadopago.payments.update-payment",
  "initial_data": {
    "base_url": "value",
    "id": 123
  }
}