Upload de arquivo remessa (CNAB)

Atenção!

A chamada deve ser autenticada seguindo o padrão descrito na seção de Upload de documentos.

Os arquivos remessa (CNAB) oferecem a possibilidade de enviar várias instruções de registros de boleto, juntamente com outros tipos de instrução (extensão, abatimento, baixa etc.), para diferentes boletos, em um único arquivo. Ao enviar instruções como as mencionadas (extensão, abatimento etc.), para boletos já existentes, o boleto é identificado pelo código da carteira (requester_profile_code) e pelo nosso número (our_number).

info

Ao fazer o upload de um arquivo CNAB, caso a requisição tenha sucesso (código de resposta 202), será criado um arquivo CNAB temporário (TemporaryCNABFile). É possível consultar o status de processamento do arquivo --- bem como possíveis erros, tanto no próprio arquivo quanto em suas ocorrências ---, utilizando os endpoints de consulta de arquivo CNAB temporário e suas ocorrências.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/cnab_file

MÉTODO

POST

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

Request Body Params

Deverão ser enviados os seguintes dados, como form-data, no body da request:

Campo	Tipo	Descrição	Caracteres
file *	file	Arquivo CNAB no padrão estipulado pela QI Tech	-

Response

STATUS

202

Response Body

{
  "temporary_cnab_file_key": "f14e9bac-94ed-4eb1-87b4-7fd7b7a2d280",
  "temporary_cnab_file_status": "accepted"
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
temporary_cnab_file_key *	uuidv4	Chave única de identificação do arquivo CNAB no formato uuid v4	36
temporary_cnab_file_status *	string	Status do arquivo CNAB	Enumeradores temporary_cnab_file_status

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 (todas as ocorrências do arquivo são rejeitadas)

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
400	BKS000022	Bad Request	Requester profile is not opened.	Carteira não está aberta.
409	BKS000053	Conflict	CNAB file already received: '<file_name>'	Arquivo CNAB já recebido: '<file_name>'