Fazer estímulo de cobrança

Use este serviço para realizar o estímulo de cobrança para seguros.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/seguros/cobranca' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "dataFaturamento": "2024-07-17", "descricaoCobranca": "Cobrança de seguro AUT", "respeitaFaturamentoMinimo": true, "valor": 11.35, "idTipoAjuste": 9, "idConta": 2001, "idExterno": "1", "codigoSeguro": "5", "codigoAdesao": "5", "usuarioCobranca": "emissor-seguros" }'

{ "dataCadastro": "2023-07-12T10:19:00", "codigoAdesao": "5", "codigoSeguro": "5", "descricaoCobranca": "Cobrança de seguro AUT", "dataFaturamento": "2024-07-17", "id": 123, "status": "ATIVO", "usuarioCobranca": "rpe-sandbox-ext", "valor": 11.35, "dataVencimento": "2023-05-10", "diaVencimento": 30, "diaCorte": 10 }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

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

dataFaturamento

string

opcional

Data de faturamento do seguro.

Exemplo:

2024-07-17

descricaoCobranca

string

requerido

Uma descrição do seguro.

Exemplo:

Cobranca de Seguro AUT

respeitaFaturamentoMinimo

boolean

requerido

Indica se respeita o valor para faturamento mínimo.

Padrão:

true

valor

number

requerido

Valor do seguro.

Exemplo:

idTipoAjuste

integer

requerido

Identificador do ajuste.

Exemplo:

idConta

integer

requerido

Identificador da conta.

Exemplo:

2001

idExterno

string

opcional

Identificador externo, dado de lançamento único (UUID).

Exemplo:

codigoSeguro

string

opcional

Código do seguro.

Exemplo:

codigoAdesao

string

opcional

Código de adesão ao seguro.

Exemplo:

usuarioCobranca

string

opcional

Usuário da cobrança.

Exemplo:

emissor-seguros

Examples

Respostas

🟢201Criado

application/json

Body

dataCadastro

string

opcional

Data de cadastro do estímulo de cobrança.

Exemplo:

2023-07-12T10:19:002024-07-03T00:00:0

codigoAdesao

string

opcional

Código de adesão ao seguro.

Exemplo:

5null

codigoSeguro

string

opcional

Código do seguro.

Exemplo:

5null

descricaoCobranca

string

opcional

Uma descrição do seguro.

Exemplo:

Cobrança de seguro AUTCobrança de seguro

dataFaturamento

string

opcional

Data de faturamento do estímulo de cobrança.

Exemplo:

2024-07-172024-08-23

integer

opcional

Identificador do lançamento.

Exemplo:

12343614055

status

enum<string>

opcional

Status do estímulo de cobrança.

Sempre ATIVO para seguradora Cards.

Valores permitidos:

ATIVOINATIVO

Padrão:

ATIVO

Exemplo:

ATIVO

usuarioCobranca

string

opcional

Usuário da cobrança.

Exemplo:

rpe-sandbox-extemissor-seguros

valor

number

opcional

Valor da cobrança.

Exemplo:

11.3510

dataVencimento

string

opcional

Data de vencimento.

Exemplo:

2023-05-102024-08-12

diaVencimento

integer

opcional

Dia exato do vencimento.

Exemplo:

diaCorte

integer

opcional

Dia do corte da fatura.

Exemplo:

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🟠422Erro de parâmetro

🔴500Erro do servidor