Para simular alguma resposta especifica utilize o campo Amount, onde de acordo com o valor dos centavos informado nesse campo é possivel receber uma resposta conforme descrito na tabela abaixo:
| Amount (valor em centavos) | Retorno simulado do Cancelamento | Exemplo de valor simulado |
|---|---|---|
| 50 | Aprovado | 5050 = R$50,50 |
| 51 | Negado | 20051 = R$200,51 |
| 52 | Timeout | 3552 = R$35,52 |
| 59 | Erro | 1059 = R$10,59 |
Requisição
| Ambiente | Método | URL |
|---|---|---|
| Sandbox | PUT | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId}/voids/{VoidId}/confirmation |
| Homologação | PUT | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId}/voids/{VoidId}/confirmation |
| Produção | PUT | https://api.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId}/voids/{VoidId}/confirmation |
Path Parameters
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| PaymentId | String guid | 36 | Sim | Código do pagamento |
| VoidId | String guid | 36 | Sim | Identificador do cancelamento |
Resposta
{
"CancellationStatus": 4,
"ConfirmatinoStatus": 1,
"Status": 2,
"ReturnCode": 0,
"ReturnMessage": "Success",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/fffef2e6-15ef-4493-869f-62ea285fbfde"
},
{
"Method": "POST",
"Rel": "void",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/fffef2e6-15ef-4493-869f-62ea285fbfde/voids"
}
]
}| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| CancellationStatus | Integer | 2 | Sim | Status do cancelamento: 0 = Não Finalizado; 1 = Autorizado; 2 = Negado; 3 = Confirmado; 4 = Desfeito |
| ConfirmationStatuss | Integer | 2 | Sim | Status da confirmação: 0 = Pendente; 1 = Confirmado; 2 = Desfeito. |
| Status | Integer | 2 | Sim | Status da transação: 0 = Não Finalizado; 1 = Autorizado; 2 = Pago; 3 = Negado; 10 = Cancelado; 13 = Abortado |
| ReturnCode | String | 3 | Sim | Código de erro/resposta da transação da adquirência |
| ReturnMessage | String | — | Sim | Mensagem de erro/resposta da transação da adquirência |