Wallet Query by Key

The wallet query by key returns the complete details of a specific wallet, including its invoice settings and credit limits.

Request

ENDPOINT

/wallet/WALLET_KEY

METHOD

GET

Path Parameters

Field	Type	Description	Characters
wallet_key	uuidv4	Unique wallet identification key	36

Response

STATUS

200

Response Body: Wallet details

{
  "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": [
    {
      "wallet_limit_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "limit_type": "postpaid_credit_limit",
      "limit_amount": 5000.00,
      "used_limit": 0.00
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

Response Body Params

Field	Type	Description	Characters
wallet_key *	string	Unique wallet identification key	36
owner_person_key *	string	Wallet owner identification key	36
owner_document_number *	string	CPF/CNPJ of the wallet owner	11-14
invoice_configuration *	object	Wallet invoice settings	Object invoice_configuration
wallet_status *	string	Current wallet status	Enumerators wallet_status
wallet_type *	string	Wallet type	Enumerators wallet_type
wallet_limits *	array	List of wallet limits	Object wallet_limits
created_at *	string	Creation date (ISO 8601 UTC format)	-

Object invoice_configuration

Field	Type	Description	Characters
closing_date_configuration *	object	Invoice closing date configuration	Object closing_date_configuration
due_date_configuration *	object	Invoice due date configuration	Object due_date_configuration
invoice_payment_type *	string	Invoice payment type	Enumerators invoice_payment_type
interest_base	string	Interest calculation base	Enumerators interest_base
monthly_interest_percentage	float	Monthly interest percentage for late payment (0-100)	-
fine_percentage	float	Fine percentage for late payment (0-100)	-

info

Note: Wallets of type payroll do not have the fields interest_base, monthly_interest_percentage and fine_percentage.

Object closing_date_configuration

Fixed Configuration (type: "fixed")

Field	Type	Description	Characters
type *	string	Configuration type (must be "fixed")	-
fixed_day *	integer	Fixed day of the month for closing (1-27)	-

Rule-based Configuration (type: "rule_based")

Field	Type	Description	Characters
type *	string	Configuration type (must be "rule_based")	-
rule *	object	Rule for date calculation	Object rule (closing_date_configuration)

Object rule (closing_date_configuration)

Field	Type	Description	Characters
day_of_week *	string	Day of the week	Enumerators day_of_week
occurrence *	string	Occurrence of the day in the month	Enumerators occurrence
fallback_strategy *	string	Strategy for non-business days	Enumerators fallback_strategy

Object due_date_configuration

Fixed Configuration (type: "fixed")

Field	Type	Description	Characters
type *	string	Configuration type (must be "fixed")	-
offset_months *	integer	Month offset from closing	-
fixed_day *	integer	Fixed day of the month for due date (2-27)	-

Rule-based Configuration (type: "rule_based")

Field	Type	Description	Characters
type *	string	Configuration type (must be "rule_based")	-
offset_months *	integer	Month offset from closing	-
rule *	object	Rule for date calculation	Object rule (due_date_configuration)

Object rule (due_date_configuration)

Field	Type	Description	Characters
day_of_week *	string	Day of the week	Enumerators day_of_week
occurrence *	string	Occurrence of the day in the month	Enumerators occurrence
fallback_strategy *	string	Strategy for non-business days	Enumerators fallback_strategy

Object wallet_limits

Field	Type	Description	Characters
limit_type *	string	Limit type	Enumerators limit_type
limit_amount *	float	Total limit amount	-
used_limit *	float	Used limit amount	-

Enumerators wallet_status

Enumerator	Description
pending_analysis	Wallet pending KYC analysis
active	Wallet active and available for use
rejected	Wallet rejected

Enumerators wallet_type

Enumerator	Description
default	Default wallet
payroll	Payroll card wallet

Enumerators limit_type

Enumerator	Description
postpaid_credit_limit	Postpaid credit limit
payroll_withdraw_limit	Payroll withdrawal limit (salary/payroll loans)

Limits in Payroll Wallets

Wallets of type payroll have two distinct limits:

• postpaid_credit_limit: Postpaid credit limit for card purchases and transactions
• payroll_withdraw_limit: Specific limit for payroll withdrawals (salary/payroll loans), which are automatically deducted from the customer's payroll

Enumerators day_of_week

Enumerator	Description
monday	Monday
tuesday	Tuesday
wednesday	Wednesday
thursday	Thursday
friday	Friday
saturday	Saturday
sunday	Sunday

Enumerators occurrence

Enumerator	Description
first	First occurrence
second	Second occurrence
third	Third occurrence
fourth	Fourth occurrence
last	Last occurrence

Enumerators fallback_strategy

Enumerator	Description
next_business_day	Next business day
previous_business_day	Previous business day
same_day	Same day

Enumerators invoice_payment_type

Enumerator	Description
bank_slip	Bank slip

Enumerators interest_base

Enumerator	Description
calendar_days	Calendar days

Object wallet_limits

Field	Type	Description	Characters
wallet_limit_key *	uuidv4	Unique identification key of the updated limit in UUID v4 format	36
limit_type *	string	Limit type	Enumerators limit_type
limit_amount *	float	Total limit amount	-
used_limit *	float	Used limit amount	-

Enumerators limit_type

Enumerator	Description
postpaid_credit_limit	Postpaid credit limit

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (pt-br) translation
404	WLT000001	Wallet Not Found	Wallet with key 8cb70dea-9fb0-4a68-9572-99a72849c8d6 not found	Carteira com chave 8cb70dea-9fb0-4a68-9572-99a72849c8d6 não encontrada