Listar arquivos remessa temporários

A listagem de arquivos CNAB temporários retornará todos os arquivos CNAB temporários da carteira que se enquadrarem nos query parameters enviados na request.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/temporary_cnab_file

MÉTODO

GET

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36

Query parameters

Campo	Tipo	Descrição	Caracteres
temporary_cnab_file_status	string	Status do arquivo CNAB temporário	Enumeradores temporary_cnab_file_status
page	integer	Número da página	-
page_size	integer	Tamanho da página	-

Enumeradores temporary_cnab_file_status

Enumerador	Descrição
uploaded	upload feito com sucesso, mas arquivo ainda não começou a ser processado
processing	arquivo sendo lido
read	arquivo lido e aceito
rejected	arquivo lido e rejeitado por erro sintático

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

Campo	Tipo	Descrição	Caracteres
data *	object array	Arquivos CNAB temporários	Objeto temporary_cnab_file
pagination *	object	Informações de paginação	Objeto pagination

Objeto temporary_cnab_file

Campo	Tipo	Descrição	Caracteres
temporary_cnab_file_key *	uuidv4	Chave única de identificação do arquivo CNAB temporário no formato uuid v4	36
temporary_cnab_file_name *	uuidv4	Nome do arquivo	100
temporary_cnab_file_status *	string	Status do arquivo CNAB temporário	Enumeradores temporary_cnab_file_status
occurrence_quantity *	integer	Quantidade de ocorrências no arquivo	-
created_at *	string	Timestamp do horário de criação do arquivo na base de dados, no formato ISO Zulu	20

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
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.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada