Search Wallet Bank Slip

The wallet bank slip search will return information about the bank slip associated with the wallet, including barcode and digitable line.

Attention

The wallet bank slip is only generated after the closure of the first invoice.

Request

ENDPOINT

/v2/invoice/wallet/WALLET_KEY/wallet_bank_slip

METHOD

GET

Path Parameters

Field	Type	Description	Characters
wallet_key	uuidv4	Wallet unique key in UUID v4 format	36

Response

STATUS

200

Response Body: Bank slip details

{
  "wallet_bank_slip_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "wallet_bank_slip_status": "accepted",
  "bank_slip_amount": 150.00,
  "bank_slip_due_date": "2024-02-15",
  "bank_slip_data": {
    "barcode": "32991090000000150001234567890123456789012345",
    "digitable_line": "32991234567890123456789012345678901234567890123"
  }
}

Response Body Params

Field	Type	Description	Characters
wallet_bank_slip_key *	uuidv4	Unique identification key of the wallet bank slip in uuid v4 format	36
wallet_bank_slip_status *	string	Bank slip status	wallet_bank_slip_status enumerators
bank_slip_amount *	float	Bank slip amount	-
bank_slip_due_date *	string	Bank slip due date (YYYY-MM-DD format)	10
bank_slip_data *	object	Bank slip data containing barcode and digitable line	bank_slip_data object

bank_slip_data object

Field	Type	Description	Characters
barcode *	string	Bank slip barcode	44
digitable_line *	string	Bank slip digitable line	47

wallet_bank_slip_status enumerators

Enumerator	Description
accepted	Bank slip accepted, awaiting registration confirmation
registered	Bank slip registered and available for payment

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	CIN000093	Not Found	Wallet bank slip was not found	Boleto da carteira não foi encontrado