Desfazimento por OrderId

Em casos onde não foi possível receber a resposta do pagamento e portanto não temos o PaymentId. Nesta situação existe a possibilidade de solicitar o desfazimento pelo número identificado no pagamento como MerchantOrderId.

Cartão digitado

Quando o pagamento não retornar, o mesmo deve ser desfeito.

Para solicitar o desfazimento é necessário informar o MerchantOrderId enviado no pagamento.

📘

O envio do desfazimento é permitido apenas para transações do dia atual.

Requisição

AmbienteMétodoEndpoint
SandboxDELETEhttps://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/orderId/{MerchantOrderId}
HomologaçãoDELETEhttps://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/orderId/{MerchantOrderId}
ProduçãoDELETEhttps://api.cieloecommerce.cielo.com.br/1/physicalSales/orderId/{MerchantOrderId}

Path parameters

PropriedadeTipoTamanhoObrigatórioDescrição
MerchantOrderIdString—SimInforme o número do documento da venda original, indicado no atributo MerchantOrderId, para a qual deseja solicitar o desfazimento. O envio do desfazimento é permitido apenas para transações do dia atual.

Resposta

{
  "ConfirmationStatus": 2,
  "Status": 2,
  "ReturnCode": 0,
  "ReturnMessage": "Success",
  "Links": [
    {
      "Method": "GET",
      "Rel": "self",
      "Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
    }
  ]
}

PropriedadeTipoTamanhoObrigatórioDescrição
ConfirmationStatusInteger (int16)——Status da confirmação:
0 = Pendente;
1 = Confirmado;
2 = Desfeito
StatusInteger (int16)——Status da transação:
0 = Não Finalizado;
1 = Autorizado;
2 = Pago;
3 = Negado;
10 = Cancelado;
13 = Abortado.
ReasonCodeInteger (int16)——Código de referência para análises
ReasonMessageString——Mensagem explicativa para análise
Links.MethodString——Enum: POST, GET, PUT. Método HTTP a ser utilizado na operação
Links.RelString——Enum: self, cancel, confirm. Referência da operação
Links.HrefString——Endereço de URL de chamada da API

Cartão com chip

Quando o pagamento não retornar, o mesmo deve ser desfeito.

Para solicitar o desfazimento é necessário informar o MerchantOrderId enviado no pagamento.

📘

O envio do desfazimento é permitido apenas para transações do dia atual.

Requisição

AmbienteMétodoEndpoint
SandboxDELETEhttps://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/orderId/{MerchantOrderId}
HomologaçãoDELETEhttps://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/orderId/{MerchantOrderId}
ProduçãoDELETEhttps://api.cieloecommerce.cielo.com.br/1/physicalSales/orderId/{MerchantOrderId}

Path parameters

PropriedadeTipoTamanhoObrigatórioDescrição
MerchantOrderIdString—SimInforme o número do documento da venda original, indicado no atributo MerchantOrderId, para a qual deseja solicitar o desfazimento. O envio do desfazimento é permitido apenas para transações do dia atual.
{
  "EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
  "IssuerScriptsResults": "0000"
}

PropriedadeTipoTamanhoObrigatórioDescrição
EmvDataString——Dados da transação EMV obtidos através do comando PP_GoOnChip na BC
IssuerScriptsResultsString——Resultado dos scripts EMV do emissor

Resposta

{
  "ConfirmationStatus": 2,
  "Status": 2,
  "ReturnCode": 0,
  "ReturnMessage": "Success",
  "Links": [
    {
      "Method": "GET",
      "Rel": "self",
      "Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
    }
  ]
}

PropriedadeTipoTamanhoObrigatórioDescrição
ConfirmationStatusInteger (int16)——Status da confirmação:
0 = Pendente;
1 = Confirmado;
2 = Desfeito
StatusInteger (int16)——Status da transação:
0 = Não Finalizado;
1 = Autorizado;
2 = Pago;
3 = Negado;
10 = Cancelado;
13 = Abortado.
ReasonCodeInteger (int16)——Código de referência para análises
ReasonMessageString——Mensagem explicativa para análise
Links.MethodString——Enum: POST, GET, PUT. Método HTTP a ser utilizado na operação
Links.RelString——Enum: self, cancel, confirm. Referência da operação
Links.HrefString——Endereço de URL de chamada da API