Payment Services
Cancel Payment
Cancellation payment. Card, Pix and BNPL payment method can be cancelled, for Pix payment method, you can only cancel dynamic QR payments; for the card payment method, you can cancel Opened or Authorized payments, which will remain with the status Cancelled or Voided respectively.
put/v1/payment/orders/{order_id}/cancel
Path parameters
order_idstring required
Order ID returned by create payment service
Headers
Content-Typestring required
The Media type of the body of the request. Default value for payment provider protocol is application/json
Acceptstring required
Acceptable media type(s) for the response. Default value for payment provider protocol is application/json
Response
Cancel payment response
Example response
{
"store": {
"code": "SBXSTORE"
},
"transaction": {
"reference_id": "REF0000001",
"business_id": "BIZ0000001",
"provider_reference": {
"tx_id": "20000000000000026628140042292"
}
},
"order_id": "9dd3f765-a51a-49d8-b6af-a51d5a0b3f7f",
"status": {
"error": {
"code": "G01",
"message": "Gateway, payment method not supported"
}
}
}