Pular para o conteúdo principal

Manual Cartão Consignado - Acompanhamento

API em desenvolvimento

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

1. Consulta da reserva do cartão consignado​

Consulta os detalhes de uma reserva específica através de sua chave (payroll_card_reservation_key) ou da chave da requisição (request_control_key). Retorna um único objeto contendo os detalhes da reserva.

GET
/payroll_card_reservation/social_security/[PAYROLL-CARD-RESERVATION-KEY]
GET
/payroll_card_reservation/social_security/request_control_key/[REQUEST-CONTROL-KEY]

Response​

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": 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": {
    "payroll_card_key": "c3d4e5f6-g7h8-9012-cdef-345678901234",
    "payroll_card_status": "pending_issuance",
    "card_limit": 2400.00
  },
  "attached_documents": [
    {
      "document_key": "d4e5f6g7-h8i9-0123-defg-456789012345",
      "document_batch_key": "e5f6g7h8-i9j0-1234-efgh-567890123456",
      "document_type": "withdrawal_operation_term",
      "document_certifier": "qi_sign",
      "document_status": "pending_generation",
      "document_url": null,
      "signature_url": null,
    },
    {
      "document_key": "f6g7h8i9-j0k1-2345-fghi-678901234567",
      "document_batch_key": "e5f6g7h8-i9j0-1234-efgh-567890123456",
      "document_type": "payroll_card_term",
      "document_certifier": "qi_sign",
      "document_status": "pending_generation",
      "document_url": null,
      "signature_url": null,
    }
  ]
}

2. Consulta de reservas do cartão consignado por CPF​

Consulta as reservas ativas de um determinado CPF. Retorna uma lista de objetos dentro da propriedade payroll_card_reservations.

GET
/payroll_card_reservation/social_security/card_holder_document_number/[CARD-HOLDER-DOCUMENT-NUMBER]

Response​

Response Body
{
   "payroll_card_reservations": [
      {
        "request_control_key": "d3bc353e-d612-4029-9d77-4dca9171c3b5",
        "payroll_card_reservation_key": "5fb9d810-be74-4d26-959d-c75d10834e93",
        "payroll_card_reservation_status": "card_issued",
        "card_holder_document_number": "12345678901",
        "identifier_number": "1234567890",
        "total_limit_amount": 8000.00,
        "reservation_amount": 250.00,
        "reservation_contract_number": "PCR0123456789",
        "wallet_key": "298e4d37-0f20-4aed-ad66-016f8487afba",
        "payroll_card_type": "social_security_payroll_card",
        "attached_documents": [
          {
              "document_key":"910e8de5-16af-4bc5-8ee1-4a0652ca0cbf",
              "document_type":"withdrawal_operation_term",
              "document_certifier":"qi_sign",
              "document_status":"signed",
              "document_batch_key":"f28bf87a-11cd-4d89-89c0-19229a1b31a7",
              "document_url": "https://storage.googleapis.com/example_document.pdf",
              "signature_url": "https://storage.googleapis.com/example_document_signed.pdf",
          },
          {
              "document_key":"332017f4-a0d6-463a-8557-e925a9485251",
              "document_type":"payroll_card_term",
              "document_certifier":"qi_sign",
              "document_status":"signed",
              "document_batch_key":"f28bf87a-11cd-4d89-89c0-19229a1b31a7",
              "document_url": "https://storage.googleapis.com/example_document.pdf",
              "signature_url": "https://storage.googleapis.com/example_document_signed.pdf",
          },
          {
              "document_key":"b1c3e915-6707-49f5-85a9-398ef997fdad",
              "document_type":"selfie",
              "document_certifier":"qi_sign",
              "document_status":"generated",
              "document_url":"https://storage.googleapis.com/selfie.jpeg"
          },
          {
              "document_key":"5769a335-a2ac-4913-a742-38b9d1e4abd2",
              "document_type":"document_identification",
              "document_certifier":"qi_sign",
              "document_status":"generated",
              "document_url":"https://storage.googleapis.com/cnh.jpeg"
          },
          {
              "document_key":"75577d34-4ebd-4488-aca8-b064e603c973",
              "document_type":"document_identification_back",
              "document_certifier":"qi_sign",
              "document_status":"generated",
              "document_url":"https://storage.googleapis.com/cnh_back.jpeg"
          }
        ]
      },
      {
        "request_control_key": "d3bc353e-d612-4029-9d77-4dca9171c3b5",
        "payroll_card_reservation_key": "5fb9d810-be74-4d26-959d-c75d10834e93",
        "payroll_card_reservation_status": "pending_withdrawal_disbursement",
        "card_holder_document_number": "12345678901",
        "identifier_number": "1234567890",
        "total_limit_amount": 8000.00,
        "reservation_amount": 250.00,
        "reservation_contract_number": "PCR0123456789",
        "wallet_key": "298e4d37-0f20-4aed-ad66-016f8487afba",
        "payroll_card_type": "social_security_payroll_card",
        "attached_documents": [
          {
              "document_key":"910e8de5-16af-4bc5-8ee1-4a0652ca0cbf",
              "document_type":"withdrawal_operation_term",
              "document_certifier":"qi_sign",
              "document_status":"signed",
              "document_batch_key":"f28bf87a-11cd-4d89-89c0-19229a1b31a7",
              "document_url": "https://storage.googleapis.com/example_document.pdf",
              "signature_url": "https://storage.googleapis.com/example_document_signed.pdf",
          },
          {
              "document_key":"332017f4-a0d6-463a-8557-e925a9485251",
              "document_type":"payroll_card_term",
              "document_certifier":"qi_sign",
              "document_status":"signed",
              "document_batch_key":"f28bf87a-11cd-4d89-89c0-19229a1b31a7",
              "document_url": "https://storage.googleapis.com/example_document.pdf",
              "signature_url": "https://storage.googleapis.com/example_document_signed.pdf",
          },
          {
              "document_key":"b1c3e915-6707-49f5-85a9-398ef997fdad",
              "document_type":"selfie",
              "document_certifier":"qi_sign",
              "document_status":"generated",
              "document_url":"https://storage.googleapis.com/selfie.jpeg"
          },
          {
              "document_key":"5769a335-a2ac-4913-a742-38b9d1e4abd2",
              "document_type":"document_identification",
              "document_certifier":"qi_sign",
              "document_status":"generated",
              "document_url":"https://storage.googleapis.com/cnh.jpeg"
          },
          {
              "document_key":"75577d34-4ebd-4488-aca8-b064e603c973",
              "document_type":"document_identification_back",
              "document_certifier":"qi_sign",
              "document_status":"generated",
              "document_url":"https://storage.googleapis.com/cnh_back.jpeg"
          }
        ]
      }
   ]
}

3. Máquinas de Status​

Payroll Card Reservation​

A entidade Payroll Card Reservation possui os seguintes status e transições:

Descrição dos Status​

StatusDescrição
pending_document_generationAguardando geração dos documentos para assinatura
pending_onboardingAguardando processo de onboarding e KYC
pending_collateral_reservationAguardando reserva do colateral
pending_withdrawal_disbursementAguardando desembolso da operação de saque
pending_card_issuanceAguardando criação da wallet e emissão do cartão
card_issuedCartão criado e ativo
canceledOperação cancelada

Withdrawal​

A entidade Withdrawal possui os seguintes status e transições:

Descrição dos Status​

StatusDescrição
pending_signatureAguardando assinatura dos termos
pending_disbursementAguardando desembolso da operação de saque
openedDesembolso realizado e operação ativa
canceledOperação cancelada