Pular para o conteúdo principal

Listar de Carteiras (Wallets)

A listagem de carteiras retornará todas as carteiras que se enquadrarem nos query parameters enviados na request.

Request​

ENDPOINT
/wallets
MÉTODO
GET

Query Parameters​

CampoTipoDescriçãoCaracteres
owner_document_numberstringCPF/CNPJ do proprietário da carteira11-14
wallet_statusstringStatus da carteira para filtrarEnumeradores wallet_status
pageintegerNúmero da página para paginação-
page_sizeintegerQuantidade de itens por página-
Validações
  • Paginação: Valores de página e tamanho devem ser inteiros válidos
  • Tamanho da página: Máximo de 100 itens por página

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

Response​

STATUS
200
Response Body: Lista de carteiras
{
  "data": [
    {
      "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",
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "request_control_key": "e1d7ca45-8180-48e4-a293-1f08a046693e",
      "wallet_key": "9db81efb-0ac1-5b79-0683-00b8395a9e7",
      "owner_document_number": "98765432100",
      "invoice_configuration": {
        "closing_date_configuration": {
          "type": "rule_based",
          "rule": {
            "day_of_week": "friday",
            "occurrence": "last",
            "fallback_strategy": "previous_business_day"
          }
        },
        "due_date_configuration": {
          "type": "rule_based",
          "offset_months": 1,
          "rule": {
            "day_of_week": "monday",
            "occurrence": "first",
            "fallback_strategy": "next_business_day"
          }
        },
        "invoice_payment_type": "bank_slip",
        "interest_base": "calendar_days",
        "monthly_interest_percentage": 1.5,
        "fine_percentage": 2.0
      },
      "wallet_status": "pending_analysis",
      "wallet_type": "default",
      "created_at": "2024-01-14T14:45:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100,
  }
}

Response Body Params​

CampoTipoDescriçãoCaracteres
data *object arrayCarteirasObjeto wallet
pagination *objectInformações de paginaçãoObjeto pagination

Objeto wallet​

CampoTipoDescriçãoCaracteres
wallet_key *uuidv4Chave ú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 ou 14
invoice_configuration *objectConfiguração de fechamento e vencimentoObjeto invoice_configuration
wallet_status *stringStatus atual da carteiraEnumeradores wallet_status
wallet_type *stringTipo da carteiraEnumeradores wallet_type
created_at *stringData de criação (formato ISO 8601 UTC)-

Objeto pagination​

CampoTipoDescriçãoCaracteres
current_page *integerPágina atual-
rows_per_page *integerItens por página-

Enumeradores wallet_type​

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

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 (closing_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

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

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
400BKS000012Bad RequestInvalid integer value for page or size query string parametersValor inválido para parâmetros de página ou tamanho de página
400BKS000013Bad RequestInvalid query wallet statusStatus de consulta de carteira inválido