Quando o pagamento retorna, ele devolve o PaymentId em seu corpo e este é o melhor identificador do pagamento e pode ser utilizado para solicitar seu desfazimento.
Cartão digitado
O pagamento retornou com sucesso e pode ser desfeito.
Deve-se solicitar o desfazimento através do PaymentId recebido no retorno do pagamento.
Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | DELETE | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId} |
| Homologação | DELETE | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId} |
| Produção | DELETE | https://api.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId} |
Path Parameters
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
PaymentId | String uuid | --- | Sim | Código do Pagamento |
Resposta
{
"ConfirmationStatus": 2,
"Status": 2,
"ReturnCode": 0,
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
}
]
}| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| ConfirmationStatus | Integer (int16) | — | — | Status da confirmação: 0 = Pendente; 1 = Confirmado; 2 = Desfeito |
| Status | Integer (int16) | — | — | Status da transação: 0 = Não Finalizado; 1 = Autorizado; 2 = Pago; 3 = Negado; 10 = Cancelado; 13 = Abortado |
| ReasonCode | Integer (int16) | — | — | Código de referência para análises |
| ReasonMessage | String | — | — | Mensagem explicativa para análise |
| Links.Method | String | — | — | Enum: POST, GET, PUT. Método HTTP da operação |
| Links.Rel | String | — | — | Enum: self, cancel, confirm. Referência da operação |
| Links.Href | String | — | — | URL para chamada da API |
Cartão com chip
O pagamento retornou com sucesso e pode ser desfeito.
Deve-se solicitar o desfazimento através do PaymentId recebido no retorno do pagamento.
Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | DELETE | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId} |
| Homologação | DELETE | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId} |
| Produção | DELETE | https://api.cieloecommerce.cielo.com.br/1/physicalSales/{PaymentId} |
Path Parameters
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
PaymentId | String uuid | --- | Sim | Código do Pagamento |
{
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"IssuerScriptsResults": "0000"
}| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| EmvData | String | — | — | Dados da transação EMV. Dados obtidos através do comando PP_GoOnChip na BC |
| IssuerScriptsResults | String | — | — | Resultado dos scripts EMV do emissor |
Resposta
{
"ConfirmationStatus": 2,
"Status": 2,
"ReturnCode": 0,
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
}
]
}| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| ConfirmationStatus | Integer (int16) | — | — | Status da confirmação: 0 = Pendente; 1 = Confirmado; 2 = Desfeito |
| Status | Integer (int16) | — | — | Status da transação: 0 = Não Finalizado; 1 = Autorizado; 2 = Pago; 3 = Negado; 10 = Cancelado; 13 = Abortado |
| ReasonCode | Integer (int16) | — | — | Código de referência para análises |
| ReasonMessage | String | — | — | Mensagem explicativa para análise |
| Links.Method | String | — | — | Enum: POST, GET, PUT. Método HTTP a ser utilizado |
| Links.Rel | String | — | — | Enum: self, cancel, confirm. Referência da operação |
| Links.Href | String | — | — | Endereço de URL de chamada da API |
| `` |