Void a credit card payment

put

https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void

Cancel or refund a credit card transaction.

Environment	Method	Endpoint
Sandbox	put	`https://apisandbox.braspag.com.br//v2/sales/{PaymentId}/void?amount=xxx`
Production	put	`https://api.braspag.com.br//v2/sales/{PaymentId}/void?amount=xxx`

⚠️
New mandatory field for voiding transactions due to fraud risk
As of 04/17/2026, it will be mandatory to provide the Reason field when the void reason is fraud risk identified by the merchant.
Set Reason = "HighRisk" in the request body, as shown in the example below:
{
  "Reason": "HighRisk"
}

Total void

To totally void a transaction, it is not necessary to send the Amount field.

Partial void

Environment	Method	Endpoint
Sandbox	put	`https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void?amount={Amount}`
Production	put	`https://api.braspag.com.br/v2/sales/{PaymentId}/void?amount={Amount}`

To partially void a transaction, include in the Amount field the amount in cents that you wish to void.

⚠️
It is not possible to partially void a transaction that was not captured.
To partially void a transaction, the Capture field must be "true" when creating the payment with a credit card.

The API allows you to void transactions individually.

To void a group of transactions, use the e-commerce portal. Learn more at:

How to void transactions in batch (until 11:59 PM on the day the transaction is created);

How to refund transactions in batch (from the day after the transaction is created).

Path Params

PaymentId

string

required

Order identifier field.

Query Params

Amount

string

Amount to be canceled/refunded, in cents. Note: 1. Check if your acquirer supports the cancelling or refunding of operations.
2. If the value for Amount is "0" (zero), or if Amount is not sent, the refund will consider the total captured amount.

Body Params

Reason

string

required

Indicates that the transaction was voided due to a fraud risk identified by the merchant. Possible value: "HighRisk". Size: 8.
Required if the transaction is voided because there is a fraud risk.
Valid for full or partial void.
Warning: This parameter will be available as of 04/17/2026.

Headers

MerchantId

string

required

Store identifier in the API.

MerchantKey

string

required

Public key for dual authentication in the API.

RequestId

string

Store-defined request identifier used when the merchant uses different servers for each GET/POST/PUT.

Response

New mandatory field for voiding transactions due to fraud risk

Total void

Partial void

It is not possible to partially void a transaction that was not captured.

200200