Upload de arquivo remessa (CNAB)

Atenção!

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

Request

ENDPOINT

/payments/account/ACCOUNT_KEY/remittance

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

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

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

Response Body Params

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

Enumeradores cnab_remittance_status

Enumerador	Descrição
uploaded	Upload feito com sucesso, mas arquivo ainda não começou a ser processado
processing	Arquivo sendo lido
accepted	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
409	PAP000002	Conflict	CNAB file alredy received	Arquivo CNAB já recebido
400	PAP000003	Bad Request	Invalid file name '<file_name>' . Please do not use specials characters like '!', '@', '(', ')', '$'.	Nome de arquivo invalido '<file_name>'. Favor não utilizar caracteres especiais como '!', '@', '(', ')', '$'."
403	PAP000004	Forbidden	Usuario não tem autorização para fazer essa ação	User is not allowed to do this action
404	PAP000005	Not Found	The source account key was not found	A chave da conta de origem não foi encontrada