Search Wallet Entry by Key

Searching for a wallet entry by key will return the complete details of a specific entry, including all related invoice items.

Request

ENDPOINT

/wallet/WALLET_KEY/wallet_entry/WALLET_ENTRY_KEY

METHOD

GET

Path Parameters

Field	Type	Description	Characters
wallet_key	uuidv4	Unique wallet key in UUID v4 format	36
wallet_entry_key	uuidv4	Unique entry key in UUID v4 format	36

Response

STATUS

200

Response Body: Wallet entry details

{
  "wallet_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "wallet_entry_amount": 150.00,
  "wallet_entry_settlement_key": "cc8fb19b-d1e4-4ce6-ad4c-61e0609a8f8d",
  "wallet_entry_type": "revolving_credit",
  "wallet_entry_status": "concluded",
  "invoice_items": [
    {
      "invoice_item_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "invoice_key": "f2cad6b4-2a68-9572-99a7-2849c8d6ecf8",
      "wallet_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "payment_instrument_entry_key": null,
      "installment_number": 1,
      "invoice_description": "Crédito rotativo - Taxa de juros",
      "amount": 150.00,
      "used_limit": 150.00,
      "invoice_item_status": "concluded",
      "invoice_item_due_date": "2024-02-15",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

Response Body Params

Field	Type	Description	Characters
wallet_entry_key *	uuidv4	Unique entry identification key in uuid v4 format	36
wallet_entry_amount *	float	Entry amount	-
wallet_entry_settlement_key *	string	Entry settlement key	-
wallet_entry_type *	string	Wallet entry type	wallet_entry_type enumerators
wallet_entry_status *	string	Wallet entry status	wallet_entry_status enumerators
invoice_items *	object array	Related invoice items	invoice_item object
created_at *	string	Creation date (ISO 8601 UTC format)	-

invoice_item object

Field	Type	Description	Characters
invoice_item_key *	uuidv4	Unique invoice item identification key in uuid v4 format	36
invoice_key *	uuidv4	Unique invoice identification key in uuid v4 format	36
wallet_entry_key	uuidv4	Unique wallet entry identification key in uuid v4 format	36
payment_instrument_entry_key	uuidv4	Unique payment instrument entry identification key in uuid v4 format	36
installment_number *	integer	Installment number	-
invoice_description *	string	Invoice item description	-
amount *	float	Item amount	-
used_limit *	float	Used limit	-
invoice_item_status *	string	Invoice item status	invoice_item_status enumerators
invoice_item_due_date *	string	Item due date (YYYY-MM-DD format)	10
created_at *	string	Creation date (ISO 8601 UTC format)	-

wallet_entry_type enumerators

Enumerator	Description
revolving_credit	Revolving credit
payroll_withdraw	Payroll withdrawal
payroll_overdue	Payroll overdue

Wallet Entry Types

• revolving_credit: Credit amounts made available to the customer
• payroll_withdraw: Debt generated by limit withdrawal that will be deducted monthly from INSS
• payroll_overdue: Debt generated by non-payment of the invoice and will also be deducted monthly from INSS

wallet_entry_status enumerators

Enumerator	Description
concluded	Completed entry

invoice_item_status enumerators

Enumerator	Description
concluded	Completed item
canceled	Canceled item

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	CIN000007	Wallet not Found	Wallet with key: abeca0d0-a09d-4b3b-a495-40b553422ced was not found	Carteira com a chave: abeca0d0-a09d-4b3b-a495-40b553422ced não foi encontrado
404	CIN000078	Not Found	Wallet entry with key: 8cb70dea-9fb0-4a68-9572-99a72849c8d6 was not found	Dívida da carteira com a chave: 8cb70dea-9fb0-4a68-9572-99a72849c8d6 não foi encontrado