Valid for integration with the "Cielo2" provider.
This is the new Pix integration you should follow from 09/01.
Learn more about this feature in the documentation.
You can remove a previously generated Pix QR Code if it has not been paid. If the Pix has already been paid, see how to request a Pix refund.
Request
| Environment | Method | Endpoint |
|---|---|---|
| Production | put | https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void |
The new Pix integration does not yet have a sandbox environment available.
Path parameters
| Field | Type | Description |
|---|---|---|
PaymentId | string | Payment identification number, returned by the API when creating the Pix QR Code. Size: 36. |
Header parameters
| Property | Description | Type | Size | Required |
|---|---|---|---|---|
MerchantId | Merchant identifier in the Cielo E-commerce API. | GUID | 36 | Yes |
MerchantKey | Public key for dual authentication in the Cielo E-commerce API. | string | 40 | Yes |
RequestId | Request identifier, used when the merchant uses different servers for each GET/POST/PUT. | GUID | 36 | No |
Response
{
"Status": 2,
"ReasonCode": 8,
"ReasonMessage": "Scheduled",
"ProviderReturnCode": "0",
"ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
"ReturnCode": "0",
"ReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/b8c1b2ea-e06a-4135-9389-8bdbdccacd20"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/b8c1b2ea-e06a-4135-9389-8bdbdccacd20/void"
}
]
}
The following table presents the main parameters that can be returned by the API when removing a Pix QR Code:
| Field | Type | Description |
|---|---|---|
Status | number | Transaction status. |
ReasonCode | number | Return code. |
ReasonMessage | number | Return message. |
ProviderReturnCode | number | Provider return code. |
ProviderReturnMessage | string | Provider return message. |