Refunds
Nesta seção é apresentada a consulta às formas de estorno para um pedido
Na consulta da instância é possível observar a presença do array refunds quando é solicitado o estorno para o pedido realizado e para o qual houve a abertura do SAC, conforme exemplo a seguir:
{
"instances": [
{
"action": {
"id": "RETURN",
"name": "devolução"
},
(...)
"refunds": [
{
"id": "CREDIT_CARD",
"name": "Cartão de Crédito",
"status": "CANCELLED",
"value": 89.9
}
],
"start_task_date": "2023-05-30T12:13:07.000Z",
"status": "CANCELLED",
"updated_at": "2023-05-30T12:13:07.000Z"
}
]
}
Este guia traz orientações sobre a consulta do refunds.
GET - Consultado informações para o refunds
Via API é possível consultar as formas de estorno disponíveis para o pedido ou produto ao aplicar-se um GET para o endpoint visualizado a seguir:
https://api.skyhub.com.br/sac/{code}/refunds
Request headers:
X-User-Email
email_de_usuario
X-Api-Key
token_de_integracao de sua conta SkyHub
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Accept
application/json
Content-Type
application/json
Example request:
curl --location --request GET 'https://api.skyhub.com.br/sac/Lojas Americanas-298765432198761/refunds' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 [Success] - OK: O retorno esperado trará informações sobre a forma de pagamento e o método para reembolso/estorno:
{
"refunds": [
{
"id": "CREDIT_CARD",
"name": "Cartão de crédito",
"limit": 300,
"group": "ORIGINAL_PAYMENT"
},
{
"id": "VOUCHER",
"name": "Vale",
"limit": 200,
"group": "ORIGINAL_PAYMENT"
},
{
"id": "VOUCHER",
"name": "Vale",
"limit": 500,
"group": "VOUCHER"
}
]
}
No retorno vemos os valores CREDIT_CARD e VOUCHER, sendo necessário observar as definições para o campo group
:
ORIGINAL_PAYMENT: Identifica a forma de pagamento utilizada para o pedido;
VOUCHER: Identifica o tipo de estorno a ser recebido pelo cliente.
No exemplo de retorno apresentado acima, observa-se que existem 2 tipos de voucher:
ORIGINAL_PAYMENT, com este valor para o
group
é indicado que o pedido foi comprado utilizando duas formas de pagamento (cartão de crédito e vale/voucher);Ao identificar o valor VOUCHER para o campo
group
tem-se que o reembolso será em forma de vale/voucher.
Last updated