上传汇款文件（CNAB）

注意！

调用必须按照上传文档部分所述的标准进行认证。

汇款文件（CNAB）提供了在单个文件中发送多条票据登记指令以及其他类型指令（延期、减免、核销等）的可能性，这些指令可针对不同的票据。发送上述指令（延期、减免等）用于已有票据时，票据通过钱包代码（requester_profile_code）和我方号码（our_number）进行识别。

信息

上传 CNAB 文件后，若请求成功（响应代码 202），将创建一个临时 CNAB 文件（TemporaryCNABFile）。可以使用临时 CNAB 文件查询和其记录端点来查看文件处理状态以及可能的错误。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/cnab_file

MÉTODO

POST

Path parameters

字段	类型	描述	字符数
`account_key`	uuidv4	账户唯一标识键，uuid v4 格式	36
`requester_profile_key`	uuidv4	钱包唯一标识键，uuid v4 格式	36

Request Body Params

以下数据应作为form-data在请求 body 中发送：

字段	类型	描述	字符数
`file` *	file	符合 QI Tech 规定标准的 CNAB 文件	-

Response

STATUS

202

Response Body

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

Response Body Params

字段	类型	描述	字符数
`temporary_cnab_file_key` *	uuidv4	CNAB 文件唯一标识键，uuid v4 格式	36
`temporary_cnab_file_status` *	string	CNAB 文件状态	Enumeradores temporary_cnab_file_status

Enumeradores temporary_cnab_file_status

枚举值	描述
uploaded	上传成功，但文件尚未开始处理
processing	文件正在读取中
read	文件已读取并接受
rejected	文件已读取并被拒绝（文件的所有记录均被拒绝）

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP 状态码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `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>`'

Request​

Path parameters​

Request Body Params​

Response​

Response Body Params​

Enumeradores temporary_cnab_file_status​

Error Response​