get
https://apihml-internet.cielo.com.br/refunds-api/v1/refunds//
Consulte solicitações de cancelamento e visualize status de cada requisição através de diversos parâmetros como lote de cancelamento, ID de cancelamento, data ou status.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | get | https://apihml-internet.cielo.com.br/refunds-api/v1/refunds/{refundID}/{merchantID}?limit={limit}&offset={offset |
| Produção | get | https://api-internet.cielo.com.br/cielo-refunds-exp-external/refunds/v1/ refunds/{refundID}/{merchantID}?limit={limit} &offset={offset} |
Exemplo de requisição em homologação
https://apihml-internet.cielo.com.br/refunds-api/v1/refunds/140426/2005157770
Descrição dos campos
{
"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
}
Retorno sobre o processo de cancelamento:
"detail": {
"code": Código referente ao resultado do cancelamento
"message": Descrição do resultado do cancelamento
}O status
pendingeapprovednão tem detail no JSON.