Buscar Boleto da Carteira

A busca de boleto da carteira retornará as informações do boleto bancário associado à carteira, incluindo código de barras e linha digitável.

Atenção

O boleto da carteira só é gerado a partir do fechamento da primeira fatura.

Request

ENDPOINT

/v2/invoice/wallet/WALLET_KEY/wallet_bank_slip

MÉTODO

GET

Path Parameters

Campo	Tipo	Descrição	Caracteres
wallet_key	uuidv4	Chave única da carteira no formato UUID v4	36

Response

STATUS

200

Response Body: Detalhes do boleto

{
  "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

Campo	Tipo	Descrição	Caracteres
wallet_bank_slip_key *	uuidv4	Chave única de identificação do boleto da carteira no formato uuid v4	36
wallet_bank_slip_status *	string	Status do boleto	Enumeradores wallet_bank_slip_status
bank_slip_amount *	float	Valor do boleto	-
bank_slip_due_date *	string	Data de vencimento do boleto (formato YYYY-MM-DD)	10
bank_slip_data *	object	Dados do boleto contendo código de barras e linha digitável	Objeto bank_slip_data

Objeto bank_slip_data

Campo	Tipo	Descrição	Caracteres
barcode *	string	Código de barras do boleto	44
digitable_line *	string	Linha digitável do boleto	47

Enumeradores wallet_bank_slip_status

Enumerador	Descrição
accepted	Boleto aceito, aguardando confirmação do registro
registered	Boleto registrado e disponível para pagamento

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