Valid for integration with the "Cielo2" provider.
This is the new Pix integration you should follow starting 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 | post | https://api.braspag.com.br/v2/sales/ |
The new Pix integration does not yet have a sandbox environment available.
Path parameters
| Field | Type | Description | Required |
|---|---|---|---|
PaymentId | string | Payment identification number, returned by the API when creating the Pix QR Code. Length: 36. | Yes |
Header parameters
| Property | Description | Type | Size | Required |
|---|---|---|---|---|
MerchantId | Merchant identifier in Gateway de Pagamento. | Text | 36 | Yes |
MerchantKey | Public key for dual authentication in Gateway de Pagamento. | Text | 40 | Yes |
RequestId | Request identifier, used when the merchant uses different servers for each GET/POST/PUT. | Text | 36 | No |
Response
{
"Status": 2,
"ReasonCode": 8,
"ReasonMessage": "Scheduled",
"ProviderReturnCode": "0",
"ProviderReturnMessage": "QRCode Pix removido com sucesso",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.braspag.com.br/v2/sales/34fc280a-8b98-44c9-bc8f-5911bbeef952"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.braspag.com.br/v2/sales/34fc280a-8b98-44c9-bc8f-5911bbeef952/void"
}
]
}
The table below shows the main parameters that may be returned by the Gateway de Pagamento 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 | text | Provider return message. |