Pular para o conteúdo principal

Manual Cartão Consignado

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações.

Consultas de Benefícios

Para consulta de dados do benefício e consulta da lista de benefícios, visite os seguintes itens na documentação do INSS:

1. Consulta de elegibilidade do beneficiário​

A consulta de elegibilidade permite verificar se um CPF está elegível para o cartão consignado/benefício do INSS. Esta operação é síncrona e retorna imediatamente o resultado da verificação.

Em posse dos dados de CPF e data de nascimento, é possível consultar a elegibilidade do beneficiário. Atualmente, a única validação de elegibilidade realizada é se a idade do beneficiário está entre 18 e 79 anos.

Request​

GET
/payroll_card_reservation/social_security/eligibility
Params
CampoTipoDescriçãoObrigatórioFormatação
document_numberstringNúmero de CPF do beneficiárioSim11 dígitos numéricos
birth_datedateData de nascimentoSimYYYY-MM-DD

Response​

STATUS
200 (OK)
Exemplos de Response

Elegível:

{
    "status": "eligible"
}

Não elegível - Idade fora do intervalo:

{
    "status": "not_eligible",
    "error_description": "Age 85 is not within the eligible range (18-79 years)"
}
Response Body Details
CampoTipoDescrição
statusstringStatus da elegibilidade (eligible/not_eligible)
error_descriptionstringDescrição do erro quando não elegível (opcional)

2. Simulação de saque e limite do cartão​

A simulação permite calcular o valor de saque disponível e o limite do cartão consignado baseado nos parâmetros financeiros informados. Esta operação é útil para apresentar ao beneficiário as condições antes da contratação.

Request​

POST
/payroll_card_reservation/social_security/simulation
Request Body
{
  "financial": {
    "salary_amount": 5000.00,
    "number_of_installments": 96,
    "monthly_interest_rate": 0.0246
  },
  "withdrawal": {
    "disbursement_date": "2025-08-08",
    "limit_days_to_disburse": 1,
    "withdrawal_ratio": 0.7
  },
  "collateral": {
    "collateral_type": "social_security_benefit_card"
  }
}
Request Body Details
CampoTipoDescriçãoFormataçãoObrigatório
financialobjectDados financeiros da operação-Sim
withdrawalobjectDados do saque-Sim
collateralobjectDados do colateral-Sim

Payload financial​

CampoTipoDescriçãoFormataçãoObrigatório
salary_amountnumberValor do salário do beneficiárioMínimo: 1Sim
number_of_installmentsnumberNúmero de parcelas da CCB de saqueMínimo: 1, Máximo: 96Sim
monthly_interest_ratenumberTaxa de juros mensal da CCB de saqueMínimo: 0.01, Máximo: 0.0246Sim

Payload withdrawal​

CampoTipoDescriçãoFormataçãoObrigatório
disbursement_datedateData do desembolso da CCB de saqueYYYY-MM-DDSim
limit_days_to_disbursenumberNúmero de dias limite para desembolso da CCB de saqueMínimo: 1, Máximo: 10Sim
withdrawal_rationumberParte do limite que será usado para o saqueMínimo: 0.5, Máximo: 0.7Não (default: 0.7)

Payload collateral​

CampoTipoDescriçãoFormataçãoObrigatório
collateral_typestringTipo do cartãoEnum: "social_security_benefit_card", "social_security_payroll_card"Sim

Response​

STATUS
201 (Created)
Response Body
{
  "total_limit_amount": 8000.00,
  "reservation_amount": 250.00,
  "withdrawal": {
    "withdrawal_amount": 5600.00,
    "withdrawal_data": {
      "disbursement_options": [
        {
          "disbursement_date": "2025-08-08",
          "cet": 0.0262,
          "annual_cet": 0.3643,
          "issue_amount": 5600.00,
          "prefixed_interest_rate": {
            "daily_rate": 0.0008104046,
            "interest_base": "calendar_days",
            "monthly_rate": 0.0246,
            "annual_rate": 0.3386043084
          },
          "installments": [
            {
              "total_amount": 152.5,
              "due_date": "2025-10-10",
              "installment_number": 1
            },
            {
              "total_amount": 152.5,
              "due_date": "2025-11-10",
              "installment_number": 2
            },
            {
              "total_amount": 152.5,
              "due_date": "2025-12-10",
              "installment_number": 3
            },
            ...
          ]
        }
      ]
    }
  },
  "payroll_card": {
    "card_limit": 2400.00
  }
}
Response Body Details
CampoTipoDescrição
total_limit_amountnumberValor total do limite disponível considerando saque e cartão
reservation_amountnumberValor da reserva do cartão consignado
withdrawalobjectDados do saque
withdrawal.withdrawal_amountnumberValor de desembolso calculado para CCB de saque
withdrawal.withdrawal_dataobjectDados detalhados do saque
payroll_cardobjectDados do cartão consignado
payroll_card.card_limitnumberLimite total calculado para o cartão

Payload withdrawal.withdrawal_data​

CampoTipoDescrição
disbursement_optionsarrayOpções de desembolso disponíveis

Payload disbursement_options​

CampoTipoDescrição
disbursement_datestringData do desembolso
cetnumberCusto Efetivo Total mensal
annual_cetnumberCusto Efetivo Total anual
issue_amountnumberValor de emissão
prefixed_interest_rateobjectTaxa de juros prefixada
installmentsarrayLista de parcelas

Payload prefixed_interest_rate​

CampoTipoDescrição
daily_ratenumberTaxa diária
interest_basestringBase de cálculo dos juros
monthly_ratenumberTaxa mensal
annual_ratenumberTaxa anual

Payload installments​

CampoTipoDescrição
total_amountnumberValor total da parcela
due_datestringData de vencimento
installment_numbernumberNúmero da parcela

3. Criação da operação de saque e geração do termo​

A criação da operação de saque inicia o processo de contratação do cartão consignado. Esta operação cria a reserva do cartão, gera os documentos necessários e retorna as chaves para acompanhamento do processo.

POST
/payroll_card_reservation/social_security

Request​

Request Body
{
  "request_control_key": "550e8400-e29b-41d4-a716-446655440000",
  "purchaser_document_number": "55566677000177",
  "card_holder": {
    "name": "Carlos Eduardo Lima",
    "email": "carlos.lima@email.com",
    "phone": {
      "number": "654321098",
      "area_code": "31",
      "country_code": "055"
    },
    "gender": "male",
    "address": {
      "city": "Belo Horizonte",
      "state": "MG",
      "number": "789",
      "street": "Rua das Palmeiras",
      "complement": "Casa 3",
      "postal_code": "30112000",
      "neighborhood": "Savassi"
    },
    "birth_date": "1990-09-18",
    "mother_name": "Fernanda Lima",
    "nationality": "Brasileiro",
    "document_number": "55566677788",
    "document_identification": {
      "document_identification_date": "2012-05-20",
      "document_identification_type": "rg",
      "document_identification_number": "555666777"
    }
  },
  "withdrawal": {
    "disbursement_date": "2025-12-15",
    "limit_days_to_disburse": 5,
    "withdrawal_ratio": 0.7,
    "contract_number": "PCR12345678",
    "disbursement_bank_account": {
      "name": "Carlos Eduardo Lima",
      "bank_code": "104",
      "account_digit": "3",
      "branch_number": "5678",
      "account_number": "987654321",
      "document_number": "55566677788",
      "transfer_method": "pix",
      "account_type": "checking_account"
    }
  },
  "financial": {
    "salary_amount": 8000.00,
    "number_of_installments": 96,
    "monthly_interest_rate": 0.0246
  },
  "collateral": {
    "state": "MG",
    "benefit_number": "5556667777",
    "collateral_type": "social_security_benefit_card",
    "subcorban_document_number": "12123456000101",
    "assistance_type": "pension_by_death_rural_worker"
  },
  "credit_agent": {
    "document_number": "44455566677",
    "name": "Agente de Crédito Lima"
  },
  "related_parties": [
    {
      "name": "Pedro Costa",
      "email": "pedro.costa@email.com",
      "phone": {
        "number": "765432109",
        "area_code": "21",
        "country_code": "055"
      },
      "address": {
        "city": "Rio de Janeiro",
        "state": "RJ",
        "number": "789",
        "street": "Rua Ipanema",
        "complement": "Apto 12",
        "postal_code": "22080001",
        "neighborhood": "Ipanema"
      },
      "role_type": "issuer_legal_representative",
      "person_type": "natural",
      "is_pep": false,
      "individual_document_number": "11122233344",
      "birth_date": "1980-12-05",
      "mother_name": "Lucia Costa"
    }
  ]
}
Request Body Details
CampoTipoDescriçãoFormataçãoObrigatório
request_control_keystringChave de identificação da requisiçãoUUID v4Sim
purchaser_document_numberstringCNPJ do comprador14 dígitos numéricosSim
card_holderobjectDados do portador do cartão-Sim
withdrawalobjectDados do saque-Sim
financialobjectDados financeiros da operação-Sim
collateralobjectDados do colateral-Sim
credit_agentobjectDados do agente de crédito-Sim
related_partiesarrayLista de partes relacionadas-Não

Payload card_holder​

CampoTipoDescriçãoFormataçãoObrigatório
namestringNome completo do portadorMínimo: 1 caractere válidoSim
emailstringEmail do portadorFormato de email válidoSim
phoneobjectDados do telefone-Sim
genderstringGêneroEnum: "male", "female"Sim
addressobjectEndereço do portador-Sim
birth_datedateData de nascimentoYYYY-MM-DDSim
mother_namestringNome da mãeMínimo: 1 caractere válidoSim
nationalitystringNacionalidadeMínimo: 1 caractereSim
document_numberstringCPF do portador11 dígitos numéricosSim
document_identificationobjectDados do documento de identificação-Sim
Payload phone​
CampoTipoDescriçãoFormataçãoObrigatório
numberstringNúmero do telefoneApenas númerosSim
area_codestringCódigo de áreaApenas númerosSim
country_codestringCódigo do paísApenas númerosSim
Payload address​
CampoTipoDescriçãoFormataçãoObrigatório
citystringCidadeMínimo: 1 caractereSim
statestringEstado2 caracteresSim
numberstringNúmeroMínimo: 1 caractereSim
streetstringRuaMínimo: 1 caractereSim
complementstringComplementoMínimo: 1 caractereNão
postal_codestringCEP8 dígitos numéricosSim
neighborhoodstringBairroMínimo: 1 caractereSim
Payload document_identification​
CampoTipoDescriçãoFormataçãoObrigatório
document_identification_datedateData de emissão do documentoYYYY-MM-DDSim
document_identification_typestringTipo do documentoEnum: "rg", "passport", "other"Sim
document_identification_numberstringNúmero do documentoMínimo: 1 caractereSim

Payload withdrawal​

CampoTipoDescriçãoFormataçãoObrigatório
disbursement_datedateData do desembolsoYYYY-MM-DDSim
limit_days_to_disbursenumberNúmero de dias limite para desembolsoMínimo: 1, Máximo: 10Sim
contract_numberstringNúmero do contrato3 letras maiúsculas + 8 númerosSim
disbursement_bank_accountobjectConta bancária para desembolso-Sim
Payload disbursement_bank_account​
CampoTipoDescriçãoFormataçãoObrigatório
namestringNome do titular da contaMínimo: 1 caractere válidoSim
bank_codestringCódigo do banco3 dígitos numéricosSim
account_digitstringDígito da conta1 dígito numéricoSim
branch_numberstringNúmero da agênciaApenas númerosSim
account_numberstringNúmero da contaApenas númerosSim
document_numberstringCPF do titular11 dígitos numéricosSim
transfer_methodstringMétodo de transferênciaEnum: "pix", "ted"Sim
account_typestringTipo de contaEnum: "checking_account","deposit_account","guaranteed_account","investment_account","payment_account","saving_account","salary_account"Sim

Payload financial​

CampoTipoDescriçãoFormataçãoObrigatório
salary_amountnumberValor do salário do beneficiário (valor total do benefício)Mínimo: 1Sim
number_of_installmentsnumberNúmero de parcelas das CCBs (saque e rotativo)Mínimo: 1, Máximo: 96Sim
monthly_interest_ratenumberTaxa de juros mensal das CCBs (saque e rotativo)Mínimo: 0.01, Máximo: 0.0246Sim

Payload collateral​

CampoTipoDescriçãoFormataçãoObrigatório
statestringEstado2 caracteresSim
benefit_numberstringNúmero do benefícioMínimo: 1 caractereSim
collateral_typestringTipo da garantiaEnum: "social_security_benefit_card" (Cartão Benefício), "social_security_payroll_card" (Cartão Consignado)Sim
assistance_typestringTipo do benefícioEnum: EnumeradoresSim

Payload credit_agent​

CampoTipoDescriçãoFormataçãoObrigatório
document_numberstringCPF do agente de crédito11 ou 14 dígitos numéricosSim
namestringNome do agente de créditoMínimo: 1 caractere válidoSim
CampoTipoDescriçãoFormataçãoObrigatório
namestringNome da parte relacionadaMínimo: 1 caractere válidoSim
emailstringEmail da parte relacionadaFormato de email válidoSim
phoneobjectDados do telefone-Sim
addressobjectEndereço da parte relacionada-Sim
role_typestringTipo de papelEnum: "issuer_legal_representative", "issuer_attorney"Sim
person_typestringTipo de pessoaEnum: "natural"Sim
is_pepbooleanSe é pessoa politicamente expostatrue/falseSim
individual_document_numberstringCPF da parte relacionada11 dígitos numéricosSim
birth_datedateData de nascimentoYYYY-MM-DDSim
mother_namestringNome da mãeMínimo: 1 caractere válidoSim

Response​

STATUS
201 (Created)
Response Body
{
  "request_control_key": "550e8400-e29b-41d4-a716-446655440000",
  "payroll_card_reservation_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "payroll_card_reservation_status": "pending_document_generation",
  "card_holder_document_number": "12345678901",
  "identifier_number": "1234567890",
  "total_limit_amount": 8000.00,
  "reservation_amount": 250.00,
  "reservation_contract_number": "PCR0123456789",
  "wallet_key": null,
  "payroll_card_type": "social_security_payroll_card",
  "withdrawal": {
    "withdrawal_key": "b2c3d4e5-f6g7-8901-bcde-f23456789012",
    "withdrawal_amount": 5600.00,
    "withdrawal_status": "waiting_signature",
    "contract_number": "PCR12345678",
    "withdrawal_data": {
      "disbursement_options": [
        {
          "disbursement_date": "2025-08-08",
          "cet": 0.0262,
          "annual_cet": 0.3643,
          "issue_amount": 5827.36,
          "prefixed_interest_rate": {
            "daily_rate": 0.0008104046,
            "interest_base": "calendar_days",
            "monthly_rate": 0.0246,
            "annual_rate": 0.3386043084
          },
          "installments": [
            {
              "total_amount": 164.79,
              "due_date": "2025-10-10",
              "installment_number": 1
            },
            {
              "total_amount": 152.5,
              "due_date": "2025-11-10",
              "installment_number": 2
            },
            {
              "total_amount": 152.5,
              "due_date": "2025-12-10",
              "installment_number": 3
            }
          ]
        }
      ]
    }
  },
  "payroll_card": {
    "payroll_card_key": "c3d4e5f6-g7h8-9012-cdef-345678901234",
    "payroll_card_status": "pending_issuance",
    "card_limit": 2400.00
  },
  "attached_documents": [
    {
      "document_key": "84575dcc-7a42-4ee8-818d-1b948acb7c24",
      "document_batch_key": "0a416a60-45e1-4c35-a8e8-e49dd4c4d285",
      "document_type": "withdrawal_operation_term",
      "document_certifier": "qi_sign",
      "document_status": "pending_generation",
      "document_url": null,
      "signature_url": null,
    },
    {
      "document_key": "154f828b-929e-4920-adc6-d12bc8d9dbee",
      "document_batch_key": "0a416a60-45e1-4c35-a8e8-e49dd4c4d285",
      "document_type": "payroll_card_term",
      "document_certifier": "qi_sign",
      "document_status": "pending_generation",
      "document_url": null,
      "signature_url": null,
    }
  ]
}
Response Body Details
CampoTipoDescrição
request_control_keystringChave de identificação da requisição
payroll_card_reservation_keystringChave da reserva do cartão consignado
payroll_card_reservation_statusstringStatus da reserva do cartão consignado
card_holder_document_numberstringCPF do portador do cartão
identifier_numberstringNúmero identificador da operação
reservation_amountnumberValor da reserva do cartão consignado
reservation_contract_numberstringNúmero do contrato de averbação na Dataprev
withdrawalobjectDados do saque
payroll_cardobjectDados do cartão consignado
attached_documentsarrayLista de documentos anexados
payroll_card_typestringTipo do cartão ('')
wallet_keystringChave única da wallet criada (UUID4)

Payload withdrawal​

CampoTipoDescrição
withdrawal_keystringChave única do saque
contract_numberstringNúmero do contrato da CCB de saque
withdrawal_amountnumberValor de desembolso calculado para CCB de saque
withdrawal_statusstringStatus do saque
withdrawal_dataobjectDados detalhados do saque
Payload withdrawal_data​
CampoTipoDescrição
disbursement_optionsarrayOpções de desembolso disponíveis
Payload disbursement_options​
CampoTipoDescrição
disbursement_datestringData do desembolso
cetnumberCusto Efetivo Total mensal
annual_cetnumberCusto Efetivo Total anual
issue_amountnumberValor de emissão
prefixed_interest_rateobjectTaxa de juros prefixada
installmentsarrayLista de parcelas
Payload prefixed_interest_rate​
CampoTipoDescrição
daily_ratenumberTaxa diária
interest_basestringBase de cálculo dos juros
monthly_ratenumberTaxa mensal
annual_ratenumberTaxa anual
Payload installments​
CampoTipoDescrição
total_amountnumberValor total da parcela
due_datestringData de vencimento
installment_numbernumberNúmero da parcela

Payload payroll_card​

CampoTipoDescrição
payroll_card_keystringChave única do cartão consignado
payroll_card_statusstringStatus do cartão consignado
card_limitnumberLimite total calculado para o cartão

Payload attached_documents​

CampoTipoDescrição
document_keystringChave única do documento
document_batch_keystringChave do lote de documentos
document_typestringTipo do documento
document_certifierstringCertificadora do documento
document_statusstringStatus do documento
document_urlstringURL do documento
signature_urlstringURL da assinatura

4. Anexos​

Tabela de benefícios​

códigobenefício
1pension_by_death_rural_worker
2pension_by_death_accident_rural_worker
3pension_by_death_rural_employer
4retirement_invalidity_rural_emploee
5retirement_invalidity_accident_rural_worker
6retirement_invalidity_rural_employer
7retirement_by_eldness_rural_worker
8retirement_by_age_rural_employer
9complement_by_work_accident_rural_worker
11support_invalidity_rural_worker
12support_by_age_rural_worker
13aid_sickness_rural_worker
15aid_time_off_rural_worker
16aid_federal
17international_agreement
18inclusion_benefit
19pension_student_law7004
20pension_by_death_diplomat
21pension_by_death
22pension_by_death_statute
23pension_by_death_veteran
24pension_special_institutional_act
25aid_time_off
26pension_by_death_special_law593
27pension_by_death_federal_emploee
28pension_by_death_general_regime_law20465
29pension_by_death_marine_veteran
30monthly_income_lifetime_invalidity
31aid_sickness
32retirement_invalidity_social_security
33retirement_invalidity_aeronautic
34retirement_invalidity_marine_law1756
35aid_sickness_veteran
36aid_social_security_accident
37retirement_capin_extra_emploee
38retirement_federal_extra_emploee
39aid_invalidity_student_law7004
40monthly_income_lifetime_by_age_upper70_law6179
41retirement_by_age
42retirement_by_contribution_time
43retirement_by_time_of_service_veteran
44retirement_special_aeronautic
45retirement_by_time_of_service_journalist
46retirement_special
47allowance_25
48allowance_20
49retirement_ordinary
50aid_sickness_extinct_basic_plan
51retirement_invalidity_extinct_basic_plan
52retirement_by_age_extinct_basic_plan
53aid_time_off_extinct_basic_plan
54pension_indemnity_federal
55pension_by_death_extinct_basic_plan
56pension_lifetime_syndrome_thalidomide
57retirement_by_teacher_labor_time
58retirement_anisty
59pension_by_death_amnesty
60indemnity
61aid_birth
62aid_funeral
63aid_funeral_rural_worker
64aid_funeral_rural_employer
65savings_special_autarchy
67savings_mandatory_ipase_law5128
68savings_special_retirement_ps_affiliated_upper60
69savings_student_law7004
70restitution
71monthly_income
72retirement_by_time_of_service_law1756
73monthly_income_family_statute
74complement_pension_federal
75complement_retirement_federal
76monthly_income_statute
77monthly_income_sinpas_family_statute
78retirement_by_age_law1756
79advantage
80monthly_income_maternity
81compulsory_retirement
82retirement_by_time_of_service_sasse
83retirement_invalidity_ex_sasse
84pension_by_death_sasse
85pension_lifetime_rubber_tapper_law7986
86pension_lifetime_rubber_tapper_dependent_law7986
87continuous_aid_physical_disabilities
88continuous_aid_eldness
89pension_special_hemodialysis_victim_caruaru
90medic_assistency_work_accident
91aid_sickness_by_work_accident
92retirement_invalidity_work_accident
93pension_by_death_work_accident
94aid_work_accident
95aid_additional_work_accident
96pension_special_leprosy_law11520
97savings_by_death_work_accident
98aid_longshoreman
99time_off_15