Chargeback
Quando é utilizado?
Quando o usuário deseja que o estorno parcial ou total do seu pedido seja realizado.
Este processo é feito via API Pública, usando uma aplicação externa para solicitar o estorno através de um post no endpoint POST https://api.fbits.net/pedidos/estorno/{pedidoId}.
Uma vez solicitado o estorno via API Pública, a plataforma irá enviar uma requisição usando a estrutura abaixo para o endpoint cadastrado no campo "URL" e aguardando o retorno da aplicação.
Estrutura da chamada
{urlbase}/chargeback
utiliza método POST enviando o número do pedido, o valor a ser estornado e o id da transação (custom) em uma estrutura json.
Modelo de requisição da Chargeback
Estrutura do objeto enviado e seus dados:
{
"Id": 012345,
"Pedido": 123456,
"Valor": 10.50
}
Campos da requisição da Chargeback
Campo | Tipo | Descrição |
---|---|---|
Pedido | inteiro | Código identificador do pedido |
Valor | decimal | Valor menor ou igual ao total do pedido. |
Id | inteiro | Código identificador do conector na base de dados da plataforma |
Observação Importante:
Para garantir o funcionamento correto do recurso de estorno parcial em pedidos com split, é essencial que o desenvolvimento seja feito com base no campo Id (número da transação). Isso permitirá que os clientes utilizem o recurso de estorno parcial de uma única transação, atendendo a cenários em que o pedido possui split de pagamento.
Modelo de Response
200
Em caso de erro
Caso o retorno não seja 200, basta retornar o outro código relacionado com o erro em questão.
Campos esperados no response
Campo | Tipo | Descrição |
---|---|---|
200 | HTTP | Sucesso na operação. |
400,500,etc | HTTP | Falha na operação. |
Updated 2 months ago