Cancel Payment

💡 Endpoint that processes the cancellation/refund of a sale from its unique identifier (muid).

If you are trying to cancel a transaction made more than 1 day ago, your refund will be defined as D+N.

D+N Refund: D+N transaction refunds will be applied to transactions older than one day. This will result in a refund transaction with PENDING status.

Making Request

The call must be made using the POST method. Authentication via Authorization header is required.

POST/v1/card_payments/void/{muid}

Request Parameters

Attribute	Type	Description	Required
muid	string	Unique transaction identifier	Yes
refund_tracking_number	string	Optional unique identifier generated by the client for refund transactions. Must be a 32-character hexadecimal string. Used only for D+N cancellations; ignored for normal cancellations (D0).

Tip: we recommend using a UUID v4 (32 hexadecimal characters, without hyphens) for this field to ensure global uniqueness and compliance with the required format. | No |

Request Example

POST /v1/card_payments/void/837f389330134109a5b7eb295ed95c42

Request Body

{
  "refund_tracking_number": "string"
}

Success

HTTP 200 Response Body - Example

{
  "muid": "812188b72ff1486498479c1cccd12191",
  "request_token": "E3122044DC3849C1982F5792CFB93211",
  "code": "ACCEPTED",
  "amount": 1,
  "authorization_code": "296181",
  "currency": "BRL",
  "rrn": "010003861000",
  "tracking_number": "00011109171157040010000000324831",
  "brand_response_code": "01",
  "multiacq_id": "021",
  "status": "ok"
}

Notified Events

• The system will send notifications for all available transaction statuses.
• This applies to Checkout, PixQrCode, and Card transactions.
• Any status change (Creation, confirmation, cancellation, etc.) will result in a call to the webhook configured during the transaction's creation.
• The notifications will follow the exact same data pattern already used by the existing webhook, ensuring compatibility and consistency in the integration.

For more details, please refer to Webhook - Notification for Card Payment

Errors

HTTP 422 Response Body - Unprocessable Entity - Example

{
  "errors": [
      {
          "code": "ALREADY_CANCELED",
          "msg": "The original transaction has already been canceled."
      }
  ],
  "request_token": "5EE75D660C9B4096A4AAC51E2B8393E1",
  "amount": 1,
  "currency": "BRL",
  "transaction_status": "REJECTED",
  "multiacq_id": "021",
  "status": "unprocessable_entity"
}

Response Attributes

Attribute	Type	Description
muid	string	Unique identifier
amount	number	Transaction amount
code	string	Response code
authorization_code	string	Authorization code
currency	string	Currency used in the transaction
tracking_number	string	The trackingNumber is a unique identifier used by our authorizer
rrn	string	The reference number
brand_response_code	string	Contains the response code returned by the card brand during authorization flows. Present only when the card brand approved or denied the authorization request
status	string	Request status
errors[n].code	string	Error code
errors[n].msg	string	Error message