Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void |
| Produção | put | https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void |
--header "Authorization: Bearer {access_token}"
Parâmetros no header
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization Bearer: access_token | String | -- | Sim | Token de acesso. Informe o access_token obtido para a autenticação OAuth2 |
Parâmetros no path
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
PaymentId | String | 36 | Sim | Número de identificação do pagamento. |
Resposta
{
"Status": 11,
"ReasonCode": 0,
"ReasonMessage": "Successful",
"ProviderReturnCode": "0",
"ProviderReturnMessage": "Operation Successful",
"ReturnCode": "0",
"ReturnMessage": "Operation Successful",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https:https://apisandbox.braspag.com.br/v2/sales/019efd18-c69a-4107-b5d7-e86564460cc4"
}
],
"VoidSplitPayments": [
{
"SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
"VoidedAmount": 4000,
"VoidedSplits": [
{
"MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
"VoidedAmount": 3825
},
{
"MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
"VoidedAmount": 175
}
]
},
{
"SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
"VoidedAmount": 6000,
"VoidedSplits": [
{
"MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
"VoidedAmount": 5670
},
{
"MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
"VoidedAmount": 330
}
]
}
]
}