List temporary remittance files

The listing of temporary CNAB files will return all temporary CNAB files from the wallet that match the query parameters sent in the request.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/temporary_cnab_file

METHOD

GET

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key, in uuid v4 format	36
requester_profile_key	uuidv4	Unique wallet identification key, in uuid v4 format	36

Query parameters

Field	Type	Description	Characters
temporary_cnab_file_status	string	Status of the temporary CNAB file	temporary_cnab_file_status enumerators
page	integer	Page number	-
page_size	integer	Page size	-

temporary_cnab_file_status enumerators

Enumerator	Description
uploaded	upload completed successfully, but file processing has not started yet
processing	file being read
read	file read and accepted
rejected	file read and rejected due to syntactic error

Response

STATUS

200

Response Body

{
  "data": [
    {
      "temporary_cnab_file_key": "a6db5f8b-1ed7-4d13-9cbf-f3c4275e3ca3",
      "temporary_cnab_file_name": "240903573.REM",
      "temporary_cnab_file_status": "processing",
      "occurrence_quantity": null,
      "created_at": "2024-09-07T15:44:01Z"
    },
    {
      "temporary_cnab_file_key": "2351c4ae-9a01-4675-86e4-099a30dafa42",
      "temporary_cnab_file_name": "240904603.REM",
      "temporary_cnab_file_status": "rejected",
      "occurrence_quantity": 0,
      "created_at": "2024-09-06T12:35:50Z"
    },
    {
      "temporary_cnab_file_key": "fa4f094d-8475-4828-9105-99756914e14f",
      "temporary_cnab_file_name": "240827463_t.REM",
      "temporary_cnab_file_status": "read",
      "occurrence_quantity": 10424,
      "created_at": "2024-08-28T15:09:30Z"
    },
    {
      "temporary_cnab_file_key": "e99cea6d-0d1c-4ec3-a2c6-bc603aede7c6",
      "temporary_cnab_file_name": "240827443_t.REM",
      "temporary_cnab_file_status": "read",
      "occurrence_quantity": 542,
      "created_at": "2024-08-27T20:07:11Z"
    },
    {
      "temporary_cnab_file_key": "2351c4ae-9a01-4675-86e4-099a30dafa42",
      "temporary_cnab_file_name": "240812604.REM",
      "temporary_cnab_file_status": "rejected",
      "occurrence_quantity": 0,
      "created_at": "2024-08-12T12:52:13Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Params

Field	Type	Description	Characters
data *	object array	Temporary CNAB files	temporary_cnab_file object
pagination *	object	Pagination information	pagination object

temporary_cnab_file object

Field	Type	Description	Characters
temporary_cnab_file_key *	uuidv4	Unique identification key for the temporary CNAB file in uuid v4 format	36
temporary_cnab_file_name *	uuidv4	File name	100
temporary_cnab_file_status *	string	Status of the temporary CNAB file	temporary_cnab_file_status enumerators
occurrence_quantity *	integer	Number of occurrences in the file	-
created_at *	string	Timestamp of file creation time in the database, in ISO Zulu format	20

pagination object

Field	Type	Description	Characters
current_page *	integer	Current page	-
rows_per_page *	integer	Items per page	-

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
403	BKS000005	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BKS000012	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.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada