Parcelar faturas

Use este endpoint para realizar o parcelamento manual da fatura.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/faturamentos/portador//faturas/parcelamento' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "taxaJuros": 9.5, "quantidadeParcelas": 2, "devedorTotal": true, "entrada": 30 }'

{ "quantidadeParcelas": 2, "status": "P", "idFatura": 12345678, "valorEntrada": 1368.27, "valorParcela": 1368.27, "valorTotal": 2744.43, "valorFinanciado": 2612.27, "taxaJuros": 9.99, "valorJuros": 124.27, "taxaIof": 0.0082, "taxaIofAdicional": 0.38, "valorIof": 7.89, "cet": 235.59, "dataSimulacao": "2024-03-14T14:51:56.262", "dataAtivacao": "2024-03-14T14:51:56.262", "nomeUsuario": "Usuário Cliente", "idPagamentoAtivacao": "1234", "idLancamentoAtivacao": "1234", "devedorTotal": "S", "valorJurosDevedor": 0, "valorDesconto": 0, "dataRecomendavelAtivacao": "2024-03-28T14:51:56.250+0000", "parcelas": [ { "posicao": 1, "valor": 1368.27, "principal": 1368.27, "juros": 0, "iof": 0, "dataFaturamento": "2024-03-14T14:51:56.261+0000" } ] }

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

idPortador

integer <int64>

requerido

Identificador do portador.

Padrão:

2001

Exemplo:

2001

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

opcional

One of

Processadora Cards

Processadora Dock

Informações para parcelamento manual de faturas através da processadora Cards.

taxaJuros

number

opcional

Taxa de juros aplicada na oferta.

Padrão:

9.5

Exemplo:

9.5

quantidadeParcelas

integer <int32>

opcional

Número de parcelas.

Padrão:

Exemplo:

devedorTotal

boolean

opcional

Indica se é devedor total ou não.

Padrão:

true

entrada

number <double>

opcional

Valor de entrada da fatura.

Exemplo:

Examples

Respostas

🟢200OK

application/json

Body

opcional

One of

Processadora Cards

Processadora Dock

Response sobre parcelamento manual de faturas através da processadora Cards.

quantidadeParcelas

integer

opcional

Quantidade de parcelas.

Exemplo:

status

enum<string>

opcional

Status do parcelamento.

P = Pendente

A = Ativo

C = Cancelado

Valores permitidos:

PAC

Exemplo:

idFatura

integer

opcional

Identificador da fatura.

Exemplo:

12345678

valorEntrada

number

opcional

Valor da entrada, utilizado para que o parcelamento de fatura seja ativado.

Exemplo:

1368.27

valorParcela

number

opcional

Valor das demais parcelas do refinanciamento.

Dependendo da configuração da ferramenta a entrada pode ter um valor diferente.

Exemplo:

1368.27

valorTotal

number

opcional

Valor total do refinanciamento (entrada + parcelas + IOF).

Exemplo:

2744.43

valorFinanciado

number

opcional

Valor que foi refinanciado, podendo ser apenas o da fatura atual ou saldo devedor total.

Exemplo:

2612.27

taxaJuros

number

opcional

Valor do juros incididos e já incluso no valor das parcelas.

Exemplo:

9.99

valorJuros

number

opcional

Valor do juros.

Exemplo:

124.27

taxaIof

number

opcional

Taxa de IOF.

Exemplo:

0.0082

taxaIofAdicional

number

opcional

Taxa IOF adicional.

Exemplo:

0.38

valorIof

number

opcional

Valor do IOF.

Exemplo:

7.89

cet

number

opcional

Custo Efetivo Total (CET) ao ano.

Exemplo:

235.59

dataSimulacao

string

opcional

Data da simulação do parcelamento da fatura, em formato YYYY-MM-ddTHH:mm:ss.SSSZ.

Exemplo:

2024-03-14T14:51:56.262

dataAtivacao

string

opcional

Data de ativação do parcelamento de faturas, em formato YYYY-MM-ddTHH:mm:ss.SSSZ.

Exemplo:

2024-03-14T14:51:56.262

nomeUsuario

string

opcional

Nome do usuário.

Exemplo:

Usuário Cliente

idPagamentoAtivacao

string

opcional

Identificador da ativação do pagamento.

Exemplo:

1234

idLancamentoAtivacao

string

opcional

Identificador da ativação do lançamento.

Exemplo:

1234

devedorTotal

string

opcional

Identifica se é o valor devedor total ou não.

Exemplo:

valorJurosDevedor

integer

opcional

Valor do juros devedor.

Exemplo:

valorDesconto

integer

opcional

Valor do desconto.

Exemplo:

dataRecomendavelAtivacao

string

opcional

Data limite para ativação, em formato YYYY-MM-ddTHH:mm:ss.SSSZ.

Exemplo:

2024-03-28T14:51:56.250+0000

parcelas

array [object {6}]

opcional

Informações das parcelas.

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor