Remittance file upload (CNAB)

Attention!

The call must be authenticated following the standard described in the Document upload section.

Request

ENDPOINT

/payments/account/ACCOUNT_KEY/remittance

METHOD

POST

Path parameters

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

Request Body Params

The following data must be sent as form-data in the request body:

Field	Type	Description	Characters
file *	file	CNAB file in the standard stipulated by QI Tech	-

Response

STATUS

202

Response Body

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

Response Body Params

Field	Type	Description	Characters
cnab_remittance_key *	uuidv4	Unique CNAB file identification key in uuid v4 format	36
cnab_remittance_status *	string	CNAB file status	cnab_remittance_status enumerators

cnab_remittance_status enumerators

Enumerator	Description
uploaded	Upload successful, but file hasn't started processing yet
processing	File being read
accepted	File read and accepted
rejected	File read and rejected (all file occurrences are rejected)

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 (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