上传汇款文件(CNAB)
注意!
调用必须按照文件上传部分描述的标准进行认证。
Request
ENDPOINT
/payments/account/ACCOUNT_KEY/remittanceMÉTODO
POSTPath parameters
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key | uuidv4 | 账户的唯一标识键,uuid v4 格式 | 36 |
Request Body Params
以下数据应以 form-data 格式在请求体中发送:
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
file * | file | 符合 QI Tech 规定标准的 CNAB 文件 | - |
Response
STATUS
202Response Body
{
"cnab_remittance_key": "f14e9bac-94ed-4eb1-87b4-7fd7b7a2d280",
"cnab_remittance_status": "accepted"
}
Response Body Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
cnab_remittance_key * | uuidv4 | CNAB 文件的唯一标识键,uuid v4 格式 | 36 |
cnab_remittance_status * | string | CNAB 文件状态 | Enumeradores cnab_remittance_status |
Enumeradores cnab_remittance_status
| 枚举值 | 描述 |
|---|---|
| uploaded | 上传成功,但文件尚未开始处理 |
| processing | 文件正在读取中 |
| accepted | 文件已读取并接受 |
| rejected | 文件已读取并拒绝(文件中所有记录均被拒绝) |
Error Response
STATUS
4xxResponse 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 |
| 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 |