Pular para o conteúdo principal

Manual Cartão Consignado - Emissão

Navegação
API em desenvolvimento

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

Consultas da fonte de consignação

Os dados do titular e a margem disponível vêm de consultas da própria fonte de consignação, documentadas fora deste manual:

1. Consulta de elegibilidade do beneficiário​

A consulta de elegibilidade permite verificar se um CPF está elegível para o cartão. 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 titular. Atualmente, a única validação realizada é a faixa etária, que é definida por tipo de cartão — ou seja, varia conforme a fonte de consignação e o produto informados.

Request​

GET
/payroll_card_reservation/{collateral_type}/eligibility
Testar no Playground
Params
CampoTipoDescriçãoObrigatórioFormatação
document_numberstringNúmero de CPF do titularSim11 dígitos numéricos
birth_datedateData de nascimentoSimYYYY-MM-DD
product_typestringProduto consultadoSimEnum: payroll_card, benefit_card
Consignado Público

Na fonte public_payroll, a faixa etária depende do órgão consultado, então os parâmetros consignment_entity e agency também são obrigatórios. Ver Consignado Público.

product_type ausente

product_type ausente não gera erro de validação: a consulta não resolve um tipo de cartão e é recusada com 400 PCR000004. A mensagem cita o que foi recebido — apenas a fonte de consignação quando o produto não foi informado, a fonte e o produto quando o par não corresponde a um tipo de cartão contratado.

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 72 is not within the eligible range (18-71 years)"
}

O intervalo citado na mensagem é o do tipo de cartão consultado, não um valor fixo da API.

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/{collateral_type}/simulation
Testar no Playground
Request Body
{
  "product_type": "benefit_card",
  "financial": {
    "salary_amount": 5000.00,
    "number_of_installments": 96,
    "monthly_interest_rate": 0.0246
  },
  "withdrawal": {
    "disbursement_date": "2026-01-02",
    "limit_days_to_disburse": 1,
    "withdrawal_ratio": 0.7
  }
}
Request Body Details
CampoTipoDescriçãoFormataçãoObrigatório
product_typestringProduto simuladoEnum: payroll_card, benefit_cardSim
financialobjectDados financeiros da operação-Sim
withdrawalobjectDados do saque-Sim
collateralobjectDados da consignação, quando a fonte precisa deles para precificar-Não

Payload financial​

Informe exatamente um entre salary_amount e available_margin. Qual dos dois o seu tipo de cartão aceita depende da fonte de consignação — ver Colateral por fonte de consignação.

CampoTipoDescriçãoFormataçãoObrigatório
salary_amountnumberValor do salário ou benefício do titularMínimo: 1Sim, se available_margin não for informado
available_marginnumberMargem consignável mensal disponível, já informada pelo solicitanteMínimo: 1Sim, se salary_amount não for informado
number_of_installmentsnumberNúmero de parcelas da CCB de saqueMínimo: 1Sim
monthly_interest_ratenumberTaxa de juros mensal da CCB de saqueMínimo: 0.001Sim

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: 1Sim
withdrawal_rationumberParte do limite que será usado para o saqueMínimo: 0.5Não
Limites máximos são definidos por tipo de cartão

O número de parcelas, a taxa de juros, o withdrawal_ratio e o limit_days_to_disburse têm tetos por tipo de cartão, não limites fixos de schema. Um valor acima do teto é recusado com 400 PCR000001, informando o valor recebido e o máximo permitido. Consulte a sua configuração contratada.

Response​

STATUS
201 (Created)
Response Body
{
   "total_limit_amount": 8000,
   "reservation_amount": 250,
   "withdrawal": {
      "withdrawal_amount": 5600,
      "withdrawal_data": {
         "prefixed_interest_rate": {
            "interest_base": "calendar_days",
            "annual_rate": 0.3386043084,
            "monthly_rate": 0.0246,
            "daily_rate": 0.0008104046
         },
         "disbursement_options": [
            {
               "disbursement_date": "2026-01-02",
               "cet": 0.0261,
               "annual_cet": 0.3618,
               "total_iof": 193.55,
               "disbursed_issue_amount": 5600,
               "issue_amount": 5793.55,
               "installments": [
                  {
                     "total_amount": 160.51,
                     "due_date": "2026-02-10",
                     "business_due_date": "2026-02-11",
                     "installment_number": 1
                  },
                  {
                     "total_amount": 160.51,
                     "due_date": "2026-03-10",
                     "business_due_date": "2026-03-11",
                     "installment_number": 2
                  },
                  {
                     "total_amount": 160.51,
                     "due_date": "2026-04-10",
                     "business_due_date": "2026-04-13",
                     "installment_number": 3
                  },
                  ...
               ]
            }
         ]
      }
   },
   "payroll_card": {
      "card_limit": 2400
   }
}
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
prefixed_interest_rateobjectTaxa de juros prefixada
disbursement_optionsarrayOpções de desembolso disponíveis

Payload prefixed_interest_rate​

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

Payload disbursement_options​

CampoTipoDescrição
disbursement_datestringData do desembolso
cetnumberCusto Efetivo Total mensal
annual_cetnumberCusto Efetivo Total anual
total_iofnumberValor total de IOF
disbursed_issue_amountnumberValor de desembolso
issue_amountnumberValor de emissão
installmentsarrayLista de parcelas

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/{collateral_type}
Testar no Playground

Request​

Request Body
{
  "request_control_key": "150e8400-e29b-41d4-a716-446655440000",
  "purchaser_document_number": "55566677000177",
  "product_type": "benefit_card",
  "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"
    }
  },
  "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",
      "document_identification": {
        "document_identification_date": "2017-01-14",
        "document_identification_type": "rg",
        "document_identification_number": "222333444"
      }
    }
  ],
  "withdrawal": {
    "disbursement_date": "2026-01-02",
    "limit_days_to_disburse": 1,
    "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": 5000.00,
    "number_of_installments": 96,
    "monthly_interest_rate": 0.0246,
    "emission_installments": 1
  },
  "credit_agent": {
    "document_number": "44455566677",
    "name": "Agente de Crédito Lima"
  },
  "collateral": {
    "state": "MG",
    "benefit_number": "5556667777",
    "subcorban_document_number": "12123456000101",
    "assistance_type": "pension_by_death_rural_worker"
  }
}
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
product_typestringProduto contratadoEnum: payroll_card, benefit_cardSim
card_holderobjectDados do portador do cartão-Sim
withdrawalobjectDados do saque-Sim
financialobjectDados financeiros da operação-Sim
credit_agentobjectDados do agente de crédito-Sim
related_partiesarrayLista de partes relacionadas-Não
collateralobjectDados da consignação, no formato da fonte informada na rota — ver Colateral por fonte de consignação-Sim

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 e de entrega do cartão.-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
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_attorneySim
person_typestringTipo de pessoaEnum: natural, signerSim
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
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_accountSim

Payload financial​

Informe exatamente um entre salary_amount e available_margin. Qual dos dois o seu tipo de cartão aceita depende da fonte de consignação; enviar o que não é aceito é recusado com 400 PCR000005.

CampoTipoDescriçãoFormataçãoObrigatório
salary_amountnumberValor do salário ou benefício do titular (valor total)Mínimo: 1Sim, se available_margin não for informado
available_marginnumberMargem consignável mensal disponível, já apurada pelo solicitanteMínimo: 1Sim, se salary_amount não for informado
number_of_installmentsnumberNúmero de parcelas das CCBs (saque e rotativo)Mínimo: 1Sim
monthly_interest_ratenumberTaxa de juros mensal das CCBs (saque e rotativo)Mínimo: 0.001Sim
emission_installmentsnumberNúmero de Parcelas da taxa de emissão do cartão (Conforme coletado com o beneficiário)Mínimo: 1, Máximo: 3Sim
Limites máximos são definidos por tipo de cartão

O número de parcelas, a taxa de juros, o withdrawal_ratio e o limit_days_to_disburse têm tetos por tipo de cartão, não limites fixos de schema. Um valor acima do teto é recusado com 400 PCR000001.

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

Payload collateral​

O formato do collateral é definido pela fonte de consignação informada na rota. Cada fonte tem o seu próprio conjunto de campos, todos obrigatórios.

Consignação de aposentados e pensionistas do INSS. Rota: /payroll_card_reservation/social_security. Esta fonte aceita apenas salary_amount como entrada financeira.

CampoTipoDescriçãoFormataçãoObrigatório
statestringEstado2 caracteresSim
benefit_numberstringNúmero do benefícioMínimo: 1 caractereSim
subcorban_document_numberstringNúmero do documento do correspondente bancário (ou filial de correspondente bancário) responsável pela operação14 dígitos numéricosSim
assistance_typestringTipo do benefícioEnum: Tabela de benefíciosSim
{
  "state": "MG",
  "benefit_number": "5556667777",
  "subcorban_document_number": "12123456000101",
  "assistance_type": "pension_by_death_rural_worker"
}

Regras de elegibilidade e averbação do benefício: INSS.

Response​

STATUS
201 (Created)
Response Body
{
   "request_control_key": "150e8400-e29b-41d4-a716-446655440000",
   "payroll_card_type": "social_security_benefit_card",
   "payroll_card_reservation_key": "72d63aea-15b6-402c-a18b-d12cd4619c9d",
   "card_holder_document_number": "55566677788",
   "identifier_number": "5556667777",
   "total_limit_amount": 8000,
   "reservation_amount": 250,
   "withdrawal": {
      "withdrawal_key": "56cfe7b7-ed6e-4212-8744-c9fcff309ec0",
      "withdrawal_amount": 5600,
      "credit_operation_key": null,
      "withdrawal_status": "pending_signature",
      "contract_number": "PCR12345678",
      "withdrawal_data": {
         "prefixed_interest_rate": {
            "interest_base": "calendar_days",
            "annual_rate": 0.3386043084,
            "monthly_rate": 0.0246,
            "daily_rate": 0.0008104046
         },
         "disbursement_options": [
            {
               "disbursement_date": "2026-01-02",
               "cet": 0.0261,
               "annual_cet": 0.3618,
               "total_iof": 193.55,
               "disbursed_issue_amount": 5600,
               "issue_amount":  5793.55,
               "installments": [
                  {
                     "total_amount": 160.51,
                     "due_date": "2026-02-10",
                     "business_due_date": "2026-02-11",
                     "installment_number": 1
                  },
                  {
                     "total_amount": 160.51,
                     "due_date": "2026-03-10",
                     "business_due_date": "2026-03-11",
                     "installment_number": 2
                  },
                  {
                     "total_amount": 160.51,
                     "due_date": "2026-04-10",
                     "business_due_date": "2026-04-13",
                     "installment_number": 3
                  },
                  ...
               ]
            }
         ]
      },
      "wallet_entry_key": null
   },
   "payroll_card": {
      "payroll_card_key": "572650c7-67f6-4f73-8444-b9da72000057",
      "payroll_card_status": "pending_issuance",
      "card_key": null,
      "payment_instrument_key": null,
      "card_issuance_entry_key": null,
      "card_issuance_entry_amount": 17.28,
      "card_limit": 2400
   },
   "attached_documents": [
      {
         "document_key": "32f5e5e2-a15a-40af-9ddc-cddaba1966cf",
         "document_type": "withdrawal_operation_term",
         "document_certifier": "qi_sign",
         "document_status": "pending_generation",
         "document_url": null,
         "document_batch_key": "f4f2b64c-5608-44bb-a2df-bf62cf26cc76"
      },
      {
         "document_key": "7767e30e-417e-4dd7-b061-bba722451d10",
         "document_type": "payroll_card_term",
         "document_certifier": "qi_sign",
         "document_status": "pending_generation",
         "document_url": null,
         "document_batch_key": "f4f2b64c-5608-44bb-a2df-bf62cf26cc76"
      },
      {
         "document_key": "6c839b10-9558-4e6e-9f7d-d1e494cf6156",
         "document_type": "payroll_card_consent_term",
         "document_certifier": "qi_sign",
         "document_status": "pending_generation",
         "document_url": null,
         "document_batch_key": "f4f2b64c-5608-44bb-a2df-bf62cf26cc76"
      }
   ],
   "payroll_card_reservation_status": "pending_document_generation",
   "wallet_key": null,
   "reservation_contract_number": "PCR0000000822"
}
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 — a fonte de consignação e o produto combinados, por exemplo social_security_benefit_card ou public_payroll_payroll_card
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
disbursement_datedateData de desembolso da operação
withdrawal_statusstringStatus do saque
withdrawal_dataobjectDados detalhados do saque

Payload withdrawal_data​

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

Payload prefixed_interest_rate​

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

Payload disbursement_options​

CampoTipoDescrição
disbursement_datestringData do desembolso
cetnumberCusto Efetivo Total mensal
annual_cetnumberCusto Efetivo Total anual
total_iofnumberValor total de IOF
disbursed_issue_amountnumberValor de desembolso
issue_amountnumberValor de emissão
installmentsarrayLista de parcelas

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
card_issuance_entry_amountnumberValor da Taxa de emissão do 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. Envio de documentos adicionais​

Após a aprovação do onboarding, a reserva é atualizada para o status pending_additional_documents_submission. Para prosseguir com a reserva de margem e o desembolso da operação, é obrigatório o envio dos documentos adicionais (Para o produto de Cartão Consignado/Benefício de INSS, o vídeo de confirmação da contratação).

O processamento do upload é assíncrono. O upload bem sucedido aciona a transição automática da reserva para pending_additional_documents_validation, disparando os webhooks de alteração de status e de atualização de documentos, e acionando a validação dos documentos.

Reprovação e Re-envio de Documentos Adicionais

Caso os documentos adicionais sejam rejeitados na validação do sistema, a reserva retornará para o status pending_additional_documents_submission e será possível realizar o re-envio dos documentos adicionais por este mesmo endpoint. Não é possível realizar o re-envio dos documentos adicionais antes da aprovação/rejeição pela análise do sistema, e existe um limite de 5 análises por reserva e tipo de documento.

Atenção: Gatilho de Desembolso

O envio e a subsequente aprovação pelo sistema dos documentos adicionais são tratados como autorização para o desembolso da operação de crédito. Após a validação bem sucedida dos dos arquivos, a operação seguirá automaticamente para a averbação e para a criação da operação de crédito e será efetuado o desembolso na conta do beneficiário, sem etapas adicionais de aprovação.

Request​

POST
/payroll_card_reservation/{collateral_type}/[PAYROLL-CARD-RESERVATION-KEY]/additional_documents
Testar no Playground
Params
CampoTipoDescriçãoObrigatório
payroll_card_reservation_keystringChave única da reserva (UUID)Sim
Request Body
{
  "documents": [
      {
        "document_type": "payroll_card_confirmation_video", 
        "document_url": "https://download.samplelib.com/mp4/sample-5s.mp4"
      }
  ]
}
Request Body Details
CampoTipoDescriçãoObrigatório
documentsarrayLista de documentos a serem anexadosSim

Payload documents​

CampoTipoDescriçãoFormataçãoObrigatório
document_typestringTipo do documentoEnum: "payroll_card_confirmation_video"Sim
document_urlstringURL pública para download do arquivo de vídeoURL válidaSim
URL do Vídeo

Garanta que a URL enviada é acessível por usuários externos, para conseguirmos efetuar o upload do arquivo para o banco de dados interno da QI.

  • Formatos de arquivo suportados: .mp4
  • Tamanho máximo do arquivo: 256MB

Response​

STATUS
200 (OK)

A requisição foi recebida com sucesso e o documento será processado assincronamente.

{
   "attached_documents": [
      {
         "document_key": "2fc216c6-5d1c-4713-b70b-6e1f75f8bb17",
         "document_type": "payroll_card_confirmation_video",
         "document_certifier": "electronic_client_side",
         "document_status": "pending_generation",
         "document_url": ""
      }
   ],
}

5. Reapresentação de Pagamento do Saque​

Caso o pagamento não seja processado devido a dados incorretos, é possível pode ajustar as informações da conta bancária para reapresentação através do seguinte endpoint:

PATCH
/payroll_card_reservation/{collateral_type}/[PAYROLL-CARD-RESERVATION-KEY]/disbursement_account
Testar no Playground

Request​

Request Body
{
   "disbursement_bank_account": {
      "name": "Carlos Eduardo Lima",
      "bank_code": "001",
      "account_digit": "3",
      "branch_number": "5678",
      "account_number": "987654321",
      "document_number": "55566677788",
      "transfer_method": "pix",
      "account_type": "checking_account"
   }
}
Request Body Details
CampoTipoDescriçãoFormataçãoObrigatório
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_accountSim

Response​

STATUS
200 (OK)

6. Anexos​

Referências​

Fura Fila

A funcionalidade de Fura Fila (Averbação Síncrona) está disponível apra o Cartão INSS, utilizando a payroll_card_reservation_key como a {deby_key} da requisição.:

Ambiente de Homologação (Mocks)​

Para facilitar os testes de integração em ambiente de Sandbox, o sistema simula diferentes comportamentos baseados no primeiro dígito do CPF do titular enviado no payload de criação.

Os cenários abaixo são específicos da fonte de consignação, porque simulam as respostas do órgão que averba a operação.

Os cenários simulam as respostas da Dataprev. O detalhamento por etapa — consulta de saldo, averbação e anuência — está em Mocks (Sandbox) do INSS.

1º Dígito do CPFCenárioComportamento InternoResultado Final (Cliente)
1Fluxo Ideal (Completo)Sucesso na Assinatura
Sucesso no Onboarding
Sucesso na Averbação (Dataprev)		Cartão emitido
(Status: card_issued)
2Erro na Consulta DataprevSucesso na Assinatura
Sucesso no Onboarding
Falha na Consulta de Benefício		Reserva cancelada
(Status: canceled)
+ Envio de Webhook de status
(Status: canceled)
3Erro na Averbação DataprevSucesso na Assinatura
Sucesso no Onboarding
Falha na Averbação/Reserva de Margem		Reserva cancelada
(Status: canceled)
+ Envio de Webhook de status
(Status: canceled)
4Erro de EndereçoSucesso na Assinatura
Sucesso no Onboarding (Endereço Divergente)
Sucesso na Averbação (Dataprev)		Cartão emitido
(Status: card_issued)
+ Envio de Webhook de atualização de endereço
5Onboarding RejeitadoSucesso na Assinatura
Rejeição no Onboarding/KYC		Reserva cancelada
(Status: canceled)
+ Envio de Webhook de status
(Status: canceled)
6Inelegível (Idade > 65)Sucesso na Assinatura
Sucesso no Onboarding (Retorna idade superior a 65 anos)		Reserva cancelada
(Status: canceled)
+ Envio de Webhook de status
(Status: canceled)
7Inelegível (Idade < 18)Sucesso na Assinatura
Sucesso no Onboarding (Retorna idade inferior a 18 anos)		Reserva cancelada
(Status: canceled)
+ Envio de Webhook de status
(Status: canceled)
8Teimosinha (Retentativa)Sucesso na Assinatura
Sucesso no Onboarding
Falha Temporária na Averbação (Dataprev)		Aguardando liberação
(Status: pending_reservation)
+ Envio de Webhook de Collateral
Dica

Para testar o Fluxo ideal, certifique-se de usar um CPF que comece com o dígito 1 (ex: 123.456.789-00) e que seja válido (cálculo de dígitos verificadores correto).

Aviso

Os mocks de sucesso estão configurados para simular benefícios de até R$10.000,00. Caso valores de benefício acima deste sejam usados, o sistema irá retornar erro de margem excedida na averbação, cancelando a reserva.