Cadastrar anuidades

Sandbox

https://horizon-api-sb.app.rpe.tech

POST

/api/v1/recompensas/anuidades

Use este endpoint para cadastrar anuidades.

Serviço exclusivo para processadora Dock.

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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/recompensas/anuidades' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "descricao": "ANUIDADE 001",
    "valor": 2.5,
    "cicloCobrancaInicial": 1,
    "cicloCobrancaFinal": 12,
    "ciclosIsencao": 1,
    "anoCobrancaInicial": 24,
    "anoCobrancaFinal": 28,
    "idProdutoSeguro": 1,
    "valorMinimoCompra": 5,
    "valorMaximoCompra": 999999,
    "idTipoTransacao": 2011,
    "estado": "ATIVADO",
    "bonificada": true,
    "estornavel": true,
    "valorRecobranca": 6,
    "nomeRecompensa": "ANUIDADE DEFAULT",
    "produtos": [
        1
    ]
}'

Response Example

200 - Example 1

{
    "id": 13,
    "descricao": "ANUIDADE 001",
    "valor": 2.5,
    "cicloCobrancaInicial": 1,
    "cicloCobrancaFinal": 12,
    "ciclosIsencao": 1,
    "anoCobrancaInicial": 24,
    "anoCobrancaFinal": 28,
    "idProdutoSeguro": 1,
    "valorMinimoCompra": 5,
    "valorMaximoCompra": 999999,
    "idTipoTransacao": 2011,
    "estado": "ATIVADO",
    "bonificada": true,
    "estornavel": true,
    "valorRecobranca": 6,
    "nomeRecompensa": "Anuidade default",
    "produtos": [
        1
    ],
    "idExterno": 2001
}