Cancel

POST

/dpm/payments-gwproxy/v2/payments/combined/cancel

Cancel Combined Payment

This endpoint allows you to cancel a previously authorized combined payment. It is typically used when the entire payment (made with more than one card) must be voided before capture.

Usage Scenarios:
- Full void of a combined authorization due to user request or error.
- Rejection of payment during fraud analysis or validation stage.

Notes:
- Only authorized but not captured payments can be canceled.
- All payment components involved in the combined authorization must be listed in the payments array.
- A unique request_id must be used to ensure idempotency of cancellation.
- Cancellation might not be reversible depending on the acquirer or issuer’s rules.

请求参数

Header 参数

Body 参数application/json必填

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/dpm/payments-gwproxy/v2/payments/combined/cancel' \
--header 'x-transaction-channel-entry;' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
    "payments": [
        {
            "idempotency_key": "daac03dc-73db-453f-9bea-b1391669d5d3",
            "payment_id": "2c341d28-491b-4cf8-aec7-eeb60136b7a5",
            "amount": 8900,
            "payment_method": "CREDIT",
            "custom_key": "20200630-8900",
            "payment_tag": "string"
        }
    ],
    "additional_data": {
        "property1": {},
        "property2": {}
    }
}'

返回响应

🟢200

application/json

Transação executada com sucesso.

Bodyapplication/json

示例

{
    "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
    "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
    "order_id": "ORDER-10187383",
    "amount": 8900,
    "combined_id": "66f36211-3a61-41fa-8747-052c451e89ad",
    "payments": [
        {
            "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
            "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
            "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
            "payment_id": "2c341d28-491b-4cf8-aec7-eeb60136b7a5",
            "order_id": "ORDER-10187383",
            "amount": 8900,
            "currency": "BRL",
            "status": "string",
            "reason_code": "00",
            "reason_message": "TRANSACTION EXECUTED SUCCESSFULLY",
            "canceled_at": "2020-07-01T02:15:03.603Z",
            "custom_key": "20200630-8900"
        }
    ]
}

🟠400

🟠401

🟠404

🟠422

🟠429

🔴500

🔴503

🔴504

修改于 2026-04-01 08:05:47

Capture

Get CrossBorder Quote