Listar anuidades

Sandbox

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

GET

/api/v1/anuidades

Use este endpoint para obter detalhes sobre a anuidade.

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 Query

Parâmetros Header

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 GET 'https://horizon-api-sb.app.rpe.tech/api/v1/anuidades?id&page&limit' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "count": 1,
    "page": 0,
    "limit": 15,
    "data": [
        {
            "id": 2,
            "descricao": "ANUIDADE PLUS",
            "valor": 11.99,
            "cicloCobrancaInicial": 1,
            "cicloCobrancaFinal": 12,
            "ciclosIsencao": 0,
            "anoCobrancaInicial": 0,
            "anoCobrancaFinal": 2025,
            "idProdutoSeguro": 0,
            "valorMinimoCompra": 5000,
            "valorMaximoCompra": 9999,
            "idTipoTransacao": 2011,
            "estado": "ATIVADO",
            "bonificada": true,
            "estornavel": true,
            "valorRecobranca": 0,
            "nomeRecompensa": "ANUIDADE PLUS",
            "produtos": [
                2001
            ],
            "idExterno": 2001
        }
    ]
}

Página anterior

Listar anuidade do portador

Próxima página

Listar as anuidades