API para consultar o status das parcelas da apólice do segurado

Objetivo

Esta API tem o objetivo de retornar os detalhes da parcela da apólice escolhida pelo segurado.

Contrato de Serviço - Swagger
Download Swagger
Collection Test Postman
Download Collection Test
Dados Básicos
Nome do Serviço/installment/status/list
Lista de status de parcelas
Descrição ResumidaConsulta o status das parcelas de determinada apólice
URLBase Path:
/insurance/policy/v1

URI:
/installment/status/list
StatusAtivo
Versão1.0
Exemplo de Payload

- Query `documentNumber`: string (opcional)
- Query `dueDate`: string (opcional)
- Query `key`: string (requerido)
- Query `policyCode`: string (opcional)
- Query `status`: string (opcional), pode ser `ALL`, `OPEN`, `PAID`

Exemplos: 
key=ABCSDS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
policyCode: 01.001.431.A.197904.000000
documentNumber: 95454003450
status: ALL
- Header `Authorization`: string (requerido)
- Header `X-Application-Id`: string (requerido)
- Header `X-Company-Id`: string (requerido)
- Header `X-Sucursal-Code`: string (requerido)
- Header `X-Susep-Code`: string (requerido)
- Header `X-Trace-Id`: string (opcional)
- Header `X-User-Id`: string (requerido)

Exemplos: 
Content-Type: application/json
X-Application-Id: 01
X-Broker-Check-Disable: 1
X-Company-Id: 01
X-Sucursal-Code: 001
X-Susep-Code: 00000202038300
X-Trace-Id: teste
X-User-Id: 00458954999
[
    {
        "id": 52622530,
        "policyCode": "01.102.431.A.305999.000000",
        "issueDate": "2023-06-27",
        "period": {
            "effectiveDate": "2023-06-27",
            "expirationDate": "2024-06-27"
        },
        "totalPrice": {
            "amount": 2264.98,
            "currency": "R$",
            "amountFormatted": "R$ 2264,98"
        },
        "customer": {
            "name": "FERNANDO",
            "documents": [
                {
                    "number": "99983339846",
                    "type": {
                        "id": 1,
                        "description": "CPF"
                    }
                }
            ]
        },
        "broker": {
            "id": 500021202,
            "type": {
                "id": "20",
                "description": "C"
            },
            "code": "500021202",
            "name": "CORRETORA DE SEGS XYZ LTDA",
            "sucursalCode": "102",
            "susepCode": "00000202068099",
            "document": {
                "number": "04742562999",
                "documentType": {
                    "id": 1,
                    "description": "CPF"
                }
            }
        },
        "installments": [
            {
                "id": 1,
                "quantity": 1,
                "price": {
                    "amount": 2264.97,
                    "currency": "R$",
                    "amountFormatted": "R$ 2264,97"
                },
                "billingType": {
                    "id": 7,
                    "description": "Carnê"
                },
                "status": {
                    "id": 3,
                    "description": "Vencida"
                },
                "expirationDate": "2023-07-04"
            }
        ]
    },
    {
        "id": 52622531,
        "policyCode": "01.102.431.A.309980.000001",
        "issueDate": "2023-06-27",
        "period": {
            "effectiveDate": "2023-06-27",
            "expirationDate": "2024-06-27"
        },
        "totalPrice": {
            "amount": 100.57,
            "currency": "R$",
            "amountFormatted": "R$ 100,57"
        },
        "customer": {
            "name": "FERNANDO",
            "documents": [
                {
                    "number": "99983339846",
                    "type": {
                        "id": 1,
                        "description": "CPF"
                    }
                }
            ]
        },
        "broker": {
            "id": 500021202,
            "type": {
                "id": "20",
                "description": "C"
            },
            "code": "500021202",
            "name": "CORRETORA DE SEGS XYZ LTDA",
            "sucursalCode": "102",
            "susepCode": "00000202068099",
            "document": {
                "number": "04742562999",
                "documentType": {
                    "id": 1,
                    "description": "CPF"
                }
            }
        },
        "installments": [
            {
                "id": 1,
                "quantity": 1,
                "price": {
                    "amount": 100.57,
                    "currency": "R$",
                    "amountFormatted": "R$ 100,57"
                },
                "billingType": {
                    "id": 7,
                    "description": "Carnê"
                },
                "status": {
                    "id": 2,
                    "description": "Pendente"
                },
                "expirationDate": "2023-07-27"
            }
        ]
    }
]
Informações de ambientes
Histórico de versões
AutorÁrea ou SetorVersãoDescrição da versão
OpenInsuranceIntegraçãoV1.0Versão Inicial