Listar Entradas de Carteira

A listagem de entradas de carteira retornará todas as entradas de uma carteira específica que se enquadrarem nos query parameters enviados na request.

Request

ENDPOINT

/wallet/WALLET_KEY/wallet_entries

MÉTODO

GET

Path Parameters

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

Query Parameters

Campo	Tipo	Descrição	Caracteres
wallet_entry_type *	string	Tipo da entrada da carteira	Enumeradores wallet_entry_type
wallet_entry_status *	string	Status da entrada da carteira	Enumeradores wallet_entry_status
page	integer	Número da página para paginação	-
page_size	integer	Quantidade 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_entry_type

Enumerador	Descrição
revolving_credit	Crédito rotativo
payroll_withdraw	Saque de folha
payroll_overdue	Atraso de folha

Tipos de Entrada de Carteira

• revolving_credit: Valores de crédito disponibilizados para o cliente
• payroll_withdraw: Dívida gerada pelo saque do limite e que vai ser descontada todo mês do INSS
• payroll_overdue: Dívida gerada pelo não pagamento da fatura e também vai ser descontada todo mês do INSS

Enumeradores wallet_entry_status

Enumerador	Descrição
concluded	Entrada concluída

Response

STATUS

200

Response Body: Lista de entradas de carteira

{
  "data": [
    {
      "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",
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "wallet_entry_key": "9db81efb-0ac1-5b79-0683-00b8395a9e7",
      "wallet_entry_amount": 150.00,
      "wallet_entry_settlement_key": "20cbf6e7-9535-44b4-88e3-f2c7a178a198",
      "wallet_entry_type": "payroll_withdraw",
      "wallet_entry_status": "concluded",
      "created_at": "2024-01-14T14:45:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
data *	object array	Entradas de carteira	Objeto wallet_entry
pagination *	object	Informações de paginação	Objeto pagination

Objeto wallet_entry

Campo	Tipo	Descrição	Caracteres
wallet_entry_key *	uuidv4	Chave única de identificação da entrada no formato uuid v4	36
wallet_entry_amount *	float	Valor da entrada	-
wallet_entry_settlement_key *	string	Chave de liquidação da entrada	-
wallet_entry_type *	string	Tipo da entrada da carteira	Enumeradores wallet_entry_type
wallet_entry_status *	string	Status da entrada da carteira	Enumeradores wallet_entry_status
created_at *	string	Data de criação (formato ISO 8601 UTC)	-

Objeto pagination

Campo	Tipo	Descrição	Caracteres
current_page *	integer	Página atual	-
rows_per_page *	integer	Itens por página	-

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
400	CIN000069	Bad Request	Invalid integer value for page or size query string parameters	Valor inválido para parâmetros de página ou tamanho de página
400	CIN000076	Bad Request	Invalid query wallet entry status	Status de consulta de dívida da carteira inválido
400	CIN000077	Bad Request	Invalid query wallet entry type	Tipo de consulta de dívida da carteira inválido
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