Consultar cancelamento por timeout na requisição

Essa consulta deve ser executada somente quando houver problemas na comunicação durante a solicitação de cancelamento. Deve ser realizada utilizando como base o código do Estabelecimento, um range de datas (sete dias) e um argumento de pesquisa como o código de autorização.

Essa pesquisa pode ser realizada também para localizar um cancelamento utilizando como base o código do Estabelecimento e um intervalo de datas (range de 7 dias), podendo ser combinado com mais argumentos de pesquisa como:

  • Código de autorização (authorizationCode);
  • NSU (nsu);
  • Valor da Venda (saleAmount).
AmbienteMétodoEndpoint
HomologaçãoGEThttps://apihml-internet.cielo.com.br/refunds-api/v1/refunds?cancelStartDate={DD/MM/YYYY}&cancelEndDate={DD/MM/YYYY}&rows=25&page=1&merchantId={codigo_estabelecimento}&authorizationCode={codigo_autorizacao}
ProduçãoGEThttps://api-internet.cielo.com.br/cielo-refunds-exp-external/refunds/v1/refunds?cancelStartDate={DD/MM/YYYY}&cancelEndDate={DD/MM/YYYY}&rows=25&page=1&merchantId={codigo_estabelecimento}&authorizationCode={codigo_autorizacao}
👍

Exemplo request

https://apihml-internet.cielo.com.br/refunds-api/v1/refunds?cancelStartDate=09-10-2024&cancelEndDate=10-10-2024&rows=25&page=1&merchantId=2005157770&authorizationCode=546441

Request e response

Descrição dos campos

?cancelStartDate = {Data inicial}&cancelEndDate={Data final}&rows={linha}&page={pagina}&merchantId={Estabelecimento}&authorizationCode={código de autorização}

  • cancelStartDate = Data inicial da solicitação de cancelamento (formato dd-MM-yyyy)
  • cancelEndDate = Data final da solicitação de cancelamento (formato dd-MM-yyyy)
  • rows = Quantidade de linhas
  • page = Paginação
  • merchantId = número do EC (estabelecimento comercial)
  • authorizationCode = Código de autorização da venda.
{
"refundID": Identificador do lote de cancelamento
 "refundDate": Data da solicitação do cancelamento, formato exemplo: 2019-12-27T19:38:30.547Z
 "transactions": [
        {
"transactionID": identificador de transação E-commerce.
"Nsu": Número sequencial único.
"cardNumberLast4Digits": os 4 últimos dígitos do cartão.
"merchantID": número do EC (estabelecimento comercial).
"authorizationCode": Código de autorização da venda.
"refundAmount": {
        "currency": tipo de moeda para cancelamento utilizar somente BRL.
        "value": valor para cancelar, pode ser o valor parcial ou total.
      }
"saleAmount": {
        "currency": tipo de moeda para cancelamento utilizar somente BRL.
        "value": Valor da venda.
      }
"transactionDate": no formato DD-MM-YYYY HH24:MI:SS data da venda.
"controlID": identificador do cancelamento
      "status": {
        "type": Status da solicitação 
      }

Observações:
O status pending e approved não tem detail no json.

Caso o status seja rejected (Rejeição):
"detail": {
          "code": Código da rejeição de cancelamento
          "message": Motivo da rejeição de cancelamento
        }