Pular para o conteúdo principal

Consulta de Carteira por Chave

A consulta de carteira por chave retorna os detalhes completos de uma carteira específica, incluindo suas configurações de fatura e limites de crédito.

Request​

ENDPOINT
/wallet/WALLET_KEY
MÉTODO
GET

Path Parameters​

CampoTipoDescriçãoCaracteres
wallet_keyuuidv4Chave única de identificação da carteira36

Response​

STATUS
200
Response Body: Detalhes da carteira
{
  "request_control_key": "f7947b9d-9be3-49d8-aca2-4b3249e5fa65",
  "wallet_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "owner_person_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
  "owner_document_number": "12345678901",
  "invoice_configuration": {
    "closing_date_configuration": {
      "type": "fixed",
      "fixed_day": 15
    },
    "due_date_configuration": {
      "type": "fixed",
      "fixed_day": 20,
      "offset_months": 0
    },
    "invoice_payment_type": "bank_slip",
    "interest_base": "calendar_days",
    "monthly_interest_percentage": 2.0,
    "fine_percentage": 2.0
  },
  "wallet_status": "active",
  "wallet_type": "default",
  "wallet_limits": [
    {
      "limit_type": "postpaid_credit_limit",
      "limit_amount": 5000.00,
      "used_limit": 0.00
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

Response Body Params​

CampoTipoDescriçãoCaracteres
wallet_key *stringChave única de identificação da carteira36
owner_person_key *stringChave de identificação do proprietário da carteira36
owner_document_number *stringCPF/CNPJ do proprietário da carteira11-14
invoice_configuration *objectConfigurações de fatura da carteiraObjeto invoice_configuration
wallet_status *stringStatus atual da carteiraEnumeradores wallet_status
wallet_type *stringTipo da carteiraEnumeradores wallet_type
wallet_limits *arrayLista de limites da carteiraObjeto wallet_limits
created_at *stringData de criação (formato ISO 8601 UTC)-

Objeto invoice_configuration​

CampoTipoDescriçãoCaracteres
closing_date_configuration *objectConfiguração da data de fechamento da faturaObjeto closing_date_configuration
due_date_configuration *objectConfiguração da data de vencimento da faturaObjeto due_date_configuration
invoice_payment_type *stringTipo de pagamento da faturaEnumeradores invoice_payment_type
interest_basestringBase de cálculo dos jurosEnumeradores interest_base
monthly_interest_percentagefloatPercentual de juros mensais por atraso (0-100)-
fine_percentagefloatPercentual de multa por atraso (0-100)-
info

Nota Carteiras do tipo payroll não possuem os campos interest_base, monthly_interest_percentage e fine_percentage.

Objeto closing_date_configuration​

Configuração Fixa (type: "fixed")​

CampoTipoDescriçãoCaracteres
type *stringTipo de configuração (deve ser "fixed")-
fixed_day *integerDia fixo do mês para fechamento (1-27)-

Configuração Baseada em Regras (type: "rule_based")​

CampoTipoDescriçãoCaracteres
type *stringTipo de configuração (deve ser "rule_based")-
rule *objectRegra para cálculo da dataObjeto rule (closing_date_configuration)

Objeto rule (closing_date_configuration)​

CampoTipoDescriçãoCaracteres
day_of_week *stringDia da semanaEnumeradores day_of_week
occurrence *stringOcorrência do dia no mêsEnumeradores occurrence
fallback_strategy *stringEstratégia para dias não úteisEnumeradores fallback_strategy

Objeto due_date_configuration​

Configuração Fixa (type: "fixed")​

CampoTipoDescriçãoCaracteres
type *stringTipo de configuração (deve ser "fixed")-
offset_months *integerMeses de offset a partir do fechamento-
fixed_day *integerDia fixo do mês para vencimento (2-27)-

Configuração Baseada em Regras (type: "rule_based")​

CampoTipoDescriçãoCaracteres
type *stringTipo de configuração (deve ser "rule_based")-
offset_months *integerMeses de offset a partir do fechamento-
rule *objectRegra para cálculo da dataObjeto rule (due_date_configuration)

Objeto rule (due_date_configuration)​

CampoTipoDescriçãoCaracteres
day_of_week *stringDia da semanaEnumeradores day_of_week
occurrence *stringOcorrência do dia no mêsEnumeradores occurrence
fallback_strategy *stringEstratégia para dias não úteisEnumeradores fallback_strategy

Objeto wallet_limits​

CampoTipoDescriçãoCaracteres
limit_type *stringTipo do limiteEnumeradores limit_type
limit_amount *floatValor total do limite-
used_limit *floatValor utilizado do limite-

Enumeradores wallet_status​

EnumeradorDescrição
pending_analysisCarteira pendente de análise KYC
activeCarteira ativa e disponível para uso
rejectedCarteira rejeitada na análise KYC

Enumeradores wallet_type​

EnumeradorDescrição
defaultCarteira padrão
payrollCarteira para cartão benefício

Enumeradores limit_type​

EnumeradorDescrição
postpaid_credit_limitLimite de crédito pós-pago

Enumeradores day_of_week​

EnumeradorDescrição
mondaySegunda-feira
tuesdayTerça-feira
wednesdayQuarta-feira
thursdayQuinta-feira
fridaySexta-feira
saturdaySábado
sundayDomingo

Enumeradores occurrence​

EnumeradorDescrição
firstPrimeira ocorrência
secondSegunda ocorrência
thirdTerceira ocorrência
fourthQuarta ocorrência
lastÚltima ocorrência

Enumeradores fallback_strategy​

EnumeradorDescrição
next_business_dayPróximo dia útil
previous_business_dayDia útil anterior
same_dayMesmo dia

Enumeradores invoice_payment_type​

EnumeradorDescrição
bank_slipBoleto bancário

Enumeradores interest_base​

EnumeradorDescrição
calendar_daysDias corridos

Objeto wallet_limits​

CampoTipoDescriçãoCaracteres
limit_type *stringTipo do limiteEnumeradores limit_type
limit_amount *floatValor total do limite-
used_limit *floatValor utilizado do limite-

Enumeradores limit_type​

EnumeradorDescrição
postpaid_credit_limitLimite de crédito pós-pago

Error Response​

STATUS
4xx
Response Body: Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
Código HTTP
status		Código QI
code		Título
title		Descrição (eng)
description		Descrição (pt-br)
translation
404WLT000001Wallet Not FoundWallet with key 8cb70dea-9fb0-4a68-9572-99a72849c8d6 not foundCarteira com chave 8cb70dea-9fb0-4a68-9572-99a72849c8d6 não encontrada