跳到主要内容

上传汇款文件(CNAB)

注意!

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

Request

ENDPOINT
/payments/account/ACCOUNT_KEY/remittance
MÉTODO
POST

Path parameters

字段类型描述字符数
account_keyuuidv4账户的唯一标识键,uuid v4 格式36

Request Body Params

以下数据应以 form-data 格式在请求体中发送:

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

Response

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

Response Body Params

字段类型描述字符数
cnab_remittance_key *uuidv4CNAB 文件的唯一标识键,uuid v4 格式36
cnab_remittance_status *stringCNAB 文件状态Enumeradores cnab_remittance_status

Enumeradores cnab_remittance_status

枚举值描述
uploaded上传成功,但文件尚未开始处理
processing文件正在读取中
accepted文件已读取并接受
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
400QIT000001Bad RequestSchema ErrorSchema Inválido
409PAP000002ConflictCNAB file alredy receivedArquivo CNAB já recebido
400PAP000003Bad RequestInvalid file name '<file_name>' . Please do not use specials characters like '!', '@', '(', ')', '$'.Nome de arquivo invalido '<file_name>'. Favor não utilizar caracteres especiais como '!', '@', '(', ')', '$'."
403PAP000004ForbiddenUsuario não tem autorização para fazer essa açãoUser is not allowed to do this action
404PAP000005Not FoundThe source account key was not foundA chave da conta de origem não foi encontrada