Cancel

POST

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

Cancel a Captured Payment

The Cancel endpoint allows merchants to reverse a previously captured payment, ensuring that the transaction amount is refunded to the customer.

Usage Scenarios:

Voiding a payment that was captured by mistake.

Handling order cancellations that require a full refund._

Notes:

Only captured payments can be canceled.

The cancellation process may vary depending on the payment method and issuer.

Some transactions may require additional processing time before the funds are returned to the customer._

请求参数

Authorization

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.pre.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api-sbx.globalgetnet.com/authentication/oauth2/access_token

Scopes:

digital-platform:gateway-api-Read and write access

Body 参数application/json必填

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/dpm/payments-gwproxy/v2/payments/cancel' \
--header 'Content-Type: application/json' \
--data '{
    "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
    "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
    "payment_id": "2c341d28-491b-4cf8-aec7-eeb60136b7a5",
    "additional_data": {
        "split": {
            "subseller_list_payment": [
                {
                    "subseller_id": "700104158",
                    "document_type": "CPF",
                    "document_number": "12345678912",
                    "subseller_sale_amount": 118708,
                    "items": [
                        {
                            "id": "MR1",
                            "description": "Product MR1.",
                            "amount": 118708,
                            "transaction_rate_percent": 1.2,
                            "transaction_rate_amount": 235,
                            "payment_plan": 3
                        }
                    ]
                }
            ]
        },
        "card": {
            "track1": "string",
            "track2": "string",
            "number": "1231231231231232",
            "expiration_month": 12,
            "expiration_year": 28
        },
        "currency": "BRL"
    },
    "amount": 118708,
    "payment_method": "CREDIT",
    "custom_key": "20200630-8900"
}'

返回响应

🟢200

application/json

Transaction executed successfully.

Bodyapplication/json

示例

{
    "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

QRCode

Create an Invoice/Boleto