Confirmar estorno de venda

Use este endpoint para confimar o estorno de uma venda via BNPL.

curl --location --request PUT 'https://horizon-api-sb.app.rpe.tech/api/v1/acheron/bnpl/transacao/pdv/venda/estorno/Estorno-sucesso-Horizon' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "cnpjEmissor": "99999999999999", "terminalOrigem": "9", "sucesso": true }'

{ "estorno": { "idTransacao": 18811430, "identificador": "Estorno-sucesso-Horizon", "cnpjEmissor": "99999999999999", "estabelecimento": "HORIZON", "status": "Ativo", "data": "2025-05-14T14:59:53-0300" }, "contrato": { "id": 3284199, "tipo": "VENDA", "nsu": "148321", "idTransacao": 18811428, "identificador": "Identificador-Venda-Para-Estorno-Horizon", "codigoBarra": "1747245927296", "cnpjEmissor": "99999999999999", "estabelecimento": "HORIZON", "cpfCnpjConsumidor": "99999999999", "nomeConsumidor": "Consumidor Horizon", "status": "Estornado", "data": "2025-05-14T14:45:20-0300", "valor": 24.98, "valorTaxaOperacao": 7, "valorTotal": 31.98, "quantidadeDeParcelas": 1, "adicionalFinanceiro": 0.1, "bloqueado": false, "elegivelVendor": true, "cdcAptosRemessaList": [], "valorTotalParcelas": 0, "cetTotal": 0, "cetMensal": 3.4, "cetAnual": 50.2, "taxaJurosParcela": 3, "diasCarencia": 0 }, "planoPagamento": { "scoreConsumidor": "B", "quantidadeDiasPrimeiraParcela": 5, "tipoTaxaOperacao": "PRIMEIRA_PARCELA", "valorTaxaOperacao": 7, "valorTaxaRepasse": 4, "descricaoProduto": "CDC", "carencia": true, "limiteMaximoDiasCarencia": 15, "taxaDeJurosMensal": 3 }, "cdcList": [ { "id": 16878724, "codigoBarra": "1747245927296-1", "numeroParcela": 1, "totalParcelas": 1, "dataEmissao": "2025-05-14T14:45:20-0300", "dataVencimento": "2025-05-19", "status": "Estornado", "valor": 25.08, "valorTaxaOperacao": 7, "multa": 0, "mora": 0, "iofDiarioAtraso": 0, "iofAdicionalAtraso": 0, "tpAmortizacaoIOF": 0.1, "tpAmortizacaoPrincipal": 24.98, "tpJurosIOF": 0, "tpJurosPrincipal": 0, "valorTotal": 32.08, "ajusteCredito": 0, "ajusteDebito": 0 } ] }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

identificador

string

requerido

Identificador único do estorno de venda, gerado de acordo com as regras do negócio.

Exemplo:

Estorno-sucesso-Horizon

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

cnpjEmissor

string

requerido

CNPJ do emissor, com 14 dígitos e sem pontuação.

Exemplo:

99999999999999

terminalOrigem

string

requerido

Terminal de origem da venda.

Exemplo:

sucesso

boolean

requerido

Indica se houve sucesso na operação.
true = sucesso no estorno da venda
false = sucesso no cancelamento do estorno da venda

Padrão:

true

Examples

Respostas

🟢200Success

application/json

Body

estorno

object

opcional

idTransacao

integer <int64>

opcional

Identificador da transação.

Exemplo:

18811430

identificador

string

opcional

Identificador do estorno.

Exemplo:

Estorno-sucesso-Horizon

cnpjEmissor

string

opcional

CNPJ do emissor, com 14 dígitos e sem pontuação.

Exemplo:

99999999999999

estabelecimento

string

opcional

Estabelecimento da transação.

Exemplo:

Estabelecimento ABC

status

enum<string>

opcional

Status da transação.

Valores permitidos:

ATIVOPENDENTECANCELADO

Exemplo:

ATIVO

data

string <date-time>

opcional

Data da transação.

Exemplo:

2025-05-14T14:59:53-0300

contrato

object

opcional

integer <int64>

opcional

Identificador do contrato.

Exemplo:

3284199

tipo

enum<string>

opcional

Tipo do contrato.

Valores permitidos:

VENDARENEGOCIADOACORDO

Exemplo:

VENDA

nsu

string

opcional

Número sequencial único do contrato.

Exemplo:

148321

idTransacao

integer <int64>

opcional

Identificador da transação.

Exemplo:

18811428

identificador

string

opcional

Identificador da transação, com informações do PDV e horário.

Exemplo:

Identificador-Venda-Para-Estorno-Horizon

codigoBarra

string

opcional

Código de barras da transação.

Exemplo:

1747245927296

cnpjEmissor

string

opcional

CNPJ do emissor, com 14 dígitos e sem pontuação.

Exemplo:

99999999999999

estabelecimento

string

opcional

Estabelecimento da transação.

Exemplo:

Estabelecimento ABC

cpfCnpjConsumidor

string

opcional

CPF ou CNPJ do cliente, sem pontuação.

Exemplo:

04266674252

nomeConsumidor

string

opcional

Nome do cliente, seja pessoa física ou pessoa jurídica.

Exemplo:

Maria José Silva

status

enum<string>

opcional

Status do contrato.

Valores permitidos:

ATIVOCANCELADOPAGOPENDENTEPENDENTE_ESTORNOESTORNADOPENDENTE_RENEGOCIACAORENEGOCIADOPENDENTE_ACORDOAGUARDANDO_FECHAMENTOFECHAMENTO_REALIZADO

Exemplo:

ESTORNADO

data

string <date-time>

opcional

Data de estabelecimento do contrato.

Exemplo:

2025-02-19T11:21:43-0300

valor

number

opcional

Valor do contrato.

Exemplo:

24.98

valorTaxaOperacao

number

opcional

Valor da taxa de operação.

Exemplo:

valorTotal

number

opcional

Valor total do contrato.

Exemplo:

31.98

quantidadeDeParcelas

integer <int32>

opcional

Exemplo:

adicionalFinanceiro

number

opcional

Adicional financeiro do contrato.

Exemplo:

0.1

bloqueado

boolean

opcional

Indica se o contrato está bloqueado.

Exemplo:

false

elegivelVendor

boolean

opcional

Indica se o contrato é elegível a ser considerado Vendor.

Exemplo:

false

cdcAptosRemessaList

array[string]

opcional

Informações sobre lista de CDCs aptos a serem Vendor.

valorTotalParcelas

number

opcional

Valor total das parcelas.

Exemplo:

cetTotal

number

opcional

Valor total do custo efetivo total.

Exemplo:

cetMensal

number

opcional

Valor mensal do custo efetivo total.

Exemplo:

3.4

cetAnual

number

opcional

Valor anual do custo efetivo total.

Exemplo:

50.2

taxaJurosParcela

number

opcional

Taxa de juros da parcela.

Exemplo:

diasCarencia

integer <int32>

opcional

Dias de carência.

Exemplo:

planoPagamento

object

opcional

scoreConsumidor

enum<string>

opcional

Valor de score do consumidor, determinado pelos motores de crédito.

Valores permitidos:

ABCDEFNAO_INFORMADO

Exemplo:

quantidadeDiasPrimeiraParcela

integer <int32>

opcional

Quantidade de dias até a primeira parcela.

Exemplo:

tipoTaxaOperacao

enum<string>

opcional

Tipo da taxa de operação.

Valores permitidos:

PRIMEIRA_PARCELAREPLICAR_EM_TODAS_AS_PARCELASISENTO

Exemplo:

PRIMEIRA_PARCELA

valorTaxaOperacao

number

opcional

Valor da taxa de operação.

Exemplo:

valorTaxaRepasse

number

opcional

Valor da taxa de repasse.

Exemplo:

descricaoProduto

string

opcional

Descrição do produto.

Exemplo:

CDC

carencia

boolean

opcional

Indica se há carência.

Exemplo:

false

limiteMaximoDiasCarencia

integer <int32>

opcional

Limite máximo para os dias de carência.

Exemplo:

taxaDeJurosMensal

integer <int32>

opcional

Taxa de juros mensal da operação.

Exemplo:

cdcList

array [object {20}]

opcional

integer <int64>

opcional

Identificador do CDC.

Exemplo:

16878724

codigoBarra

string

opcional

Código de barras do CDC.

Exemplo:

1747245927296-1

numeroParcela

integer <int32>

opcional

Número de parcelas.

Exemplo:

totalParcelas

integer <int32>

opcional

Total de parcelas do CDC.

Exemplo:

dataEmissao

string <date-time>

opcional

Data de emissão do CDC.

Exemplo:

2025-02-19T11:21:43-0300

dataVencimento

string <date-time>

opcional

Data de vencimento do CDC, no formato YYYY-MM-DD.

Exemplo:

2025-01-19

status

enum<string>

opcional

Status do CDC.

Valores permitidos:

ATIVOCANCELADOPENDENTEPENDENTE_ESTORNOESTORNADOPENDENTE_PAGAMENTOPAGOPENDENTE_ESTORNO_PAGAMENTOPENDENTE_RENEGOCIACAORENEGOCIADOPENDENTE_ACORDOEM_ACORDOPENDENTE_REVERSAO_PAGAMENTOREVERSAO_PAGAMENTOAGUARDANDO_FECHAMENTOFECHAMENTO_REALIZADO

Exemplo:

ESTORNADO

valor

number

opcional

Valor do CDC.

Exemplo:

20.08

valorTaxaOperacao

number

opcional

Valor da taxa de operação do CDC.

Exemplo:

multa

number

opcional

Valor da multa do CDC.

Exemplo:

mora

number

opcional

Valor do juros de mora do CDC.

Exemplo:

iofDiarioAtraso

number

opcional

Valor de IOF diário por atraso do CDC.

Exemplo:

iofAdicionalAtraso

number

opcional

Valor de IOF adicional por atraso.

Exemplo:

tpAmortizacaoIOF

number

opcional

Tabela Price de amortização do IOF.

Exemplo:

0.1

tpAmortizacaoPrincipal

number

opcional

Tabela Price preço de amortização principal.

Exemplo:

24.98

tpJurosIOF

number

opcional

Tabela Price do juros IOF.

Exemplo:

tpJurosPrincipal

number

opcional

Tabela Price do juros principal.

Exemplo:

valorTotal

number

opcional

Valor total do CDC.

Exemplo:

103

ajusteCredito

number

opcional

Valor de ajuste de crédito.

Exemplo:

ajusteDebito

integer

opcional

Valor de ajuste de débito.

Exemplo: