Consultar arquivo temporário

A consulta de um arquivo CNAB temporário, utilizando sua chave, retorna informações detalhadas sobre o mesmo, como, por exemplo, a quantidade de ocorrências que já foram processadas e possíveis erros encontrados no arquivo.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/temporary_cnab_file/TEMPORARY_CNAB_FILE_KEY

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
`temporary_cnab_file_key`	uuidv4	Chave única de identificação do arquivo CNAB temporário, no formato uuid v4	36

Response

STATUS

200

Response Body: Arquivo aceito (sem erros)

{
  "temporary_cnab_file_key": "fa4f094d-8475-4828-9105-99756914e14f",
  "temporary_cnab_file_name": "240827463_t.REM",
  "temporary_cnab_file_status": "read",
  "occurrence_quantity": 6,
  "total_processed_occurrences": 6,
  "created_at": "2024-08-28T15:09:30Z"
}

Response Body: Arquivo rejeitado (com erros)

{
  "temporary_cnab_file_key": "c16baa13-0969-46a7-a85f-6f975d266d9f",
  "temporary_cnab_file_name": "240905623.REM",
  "temporary_cnab_file_status": "rejected",
  "occurrence_quantity": 0,
  "total_processed_occurrences": 0,
  "created_at": "2024-09-10T15:59:25Z",
  "error_data": [
    {
      "code": "BKS000063",
      "title": "Bad Request",
      "description": "Invalid file code.",
      "translation": "Codigo de arquivo invalido.",
      "extra_fields": {
        "details": "Invalid file code. Expected: '1'. Got: '0'.",
        "file_line": 1,
        "details_pt_br": "Código de arquivo inválido. Esperado: '1'. Recebido: '0'.",
        "cnab_file_name": "240905623.REM",
        "cnab_inline_end_position": 2,
        "cnab_inline_start_position": 2
      }
    },
    {
      "code": "BKS000069",
      "title": "Bad Request",
      "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
      "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
      "extra_fields": {
        "details": "Invalid beneficiary account header on header. Expected: '1927400'. Got: '3;53179'.",
        "file_line": 1,
        "details_pt_br": "Conta do beneficiário inválida no header. Esperado: '1927400'. Recebido: '3;53179'.",
        "cnab_file_name": "240905623.REM",
        "cnab_inline_end_position": 46,
        "cnab_inline_start_position": 40
      }
    },
    {
      "code": "BKS000064",
      "title": "Bad Request",
      "description": "Invalid bank code (014).",
      "translation": "Codigo do banco invalido (014).",
      "extra_fields": {
        "details": "Invalid bank code. Expected: '329'. Got: '014'",
        "bank_code": "014",
        "details_pt_br": "Código do banco inválido. Esperado: '329'. Recebido: '014'",
        "cnab_file_name": "240905623.REM"
      }
    },
    {
      "code": "BKS000056",
      "title": "Bad Request",
      "description": "Invalid record sequence.",
      "translation": "Sequencia invalida de registros.",
      "extra_fields": {
        "cnab_line": 1,
        "cnab_file_name": "240905623.REM"
      }
    },
    {
      "code": "BKS000056",
      "title": "Bad Request",
      "description": "Invalid record sequence.",
      "translation": "Sequencia invalida de registros.",
      "extra_fields": {
        "cnab_line": 2,
        "cnab_file_name": "240905623.REM"
      }
    },
    {
      "code": "BKS000086",
      "title": "Bad Request",
      "description": "File missing trailler record.",
      "translation": "Arquivo sem registro trailler.",
      "extra_fields": {
        "file_line": 3,
        "cnab_file_name": "240905623.REM"
      }
    }
  ]
}

Response Body Params

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	-
`total_processed_occurrences` *	integer	Quantidade de ocorrências já processadas	-
`error_data`	object array	Objetos, em JSON, dos erros encontrados no arquivo, no mesmo padrão retornado pelas APIs	Objeto error_data
`created_at` *	string	Timestamp do horário de criação do arquivo na base de dados, no formato ISO Zulu	20

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

Objeto error_data

Campo	Tipo	Descrição	Caracteres
`code` *	string	Código do erro	9
`title` *	string	Título do erro	100
`description` *	string	Descrição do erro, em inglês	100
`translation` *	integer	Tradução da descrição do erro	100
`extra_fields`	object	Informações adicionais sobre o erro	-

Importante

Os campos retornados no objeto extra_fields servem para fornecer informações adicionais sobre o erro e podem variar. Portanto, não devem ser mapeados de maneira restrita.

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 (ptbr) `translation`
400	QIT000001	Bad Request	Schema Error	Schema Inválido
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
404	BKS000054	Not Found	Remittance not found with key: `{temporary_cnab_file_key}`	Remessa não encontrada com a chave: `{temporary_cnab_file_key}`

Consultar arquivo temporário

Request​

Path parameters​

Response​

Response Body Params​

Enumeradores temporary_cnab_file_status​

Objeto error_data​

Error Response​