列出临时汇款文件

临时 CNAB 文件列表将返回符合请求中发送的查询参数的所有钱包临时 CNAB 文件。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/temporary_cnab_file

MÉTODO

GET

Path parameters

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

Query parameters

字段	类型	描述	字符数
`temporary_cnab_file_status`	string	临时 CNAB 文件状态	Enumeradores temporary_cnab_file_status
`page`	integer	页码	-
`page_size`	integer	每页大小	-

Enumeradores temporary_cnab_file_status

枚举值	描述
uploaded	上传成功，但文件尚未开始处理
processing	文件正在读取中
read	文件已读取并接受
rejected	文件已读取并因语法错误被拒绝

Response

STATUS

200

Response Body

{
  "data": [
    {
      "temporary_cnab_file_key": "a6db5f8b-1ed7-4d13-9cbf-f3c4275e3ca3",
      "temporary_cnab_file_name": "240903573.REM",
      "temporary_cnab_file_status": "processing",
      "occurrence_quantity": null,
      "created_at": "2024-09-07T15:44:01Z"
    },
    {
      "temporary_cnab_file_key": "2351c4ae-9a01-4675-86e4-099a30dafa42",
      "temporary_cnab_file_name": "240904603.REM",
      "temporary_cnab_file_status": "rejected",
      "occurrence_quantity": 0,
      "created_at": "2024-09-06T12:35:50Z"
    },
    {
      "temporary_cnab_file_key": "fa4f094d-8475-4828-9105-99756914e14f",
      "temporary_cnab_file_name": "240827463_t.REM",
      "temporary_cnab_file_status": "read",
      "occurrence_quantity": 10424,
      "created_at": "2024-08-28T15:09:30Z"
    },
    {
      "temporary_cnab_file_key": "e99cea6d-0d1c-4ec3-a2c6-bc603aede7c6",
      "temporary_cnab_file_name": "240827443_t.REM",
      "temporary_cnab_file_status": "read",
      "occurrence_quantity": 542,
      "created_at": "2024-08-27T20:07:11Z"
    },
    {
      "temporary_cnab_file_key": "2351c4ae-9a01-4675-86e4-099a30dafa42",
      "temporary_cnab_file_name": "240812604.REM",
      "temporary_cnab_file_status": "rejected",
      "occurrence_quantity": 0,
      "created_at": "2024-08-12T12:52:13Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Params

字段	类型	描述	字符数
`data` *	object array	临时 CNAB 文件列表	Objeto temporary_cnab_file
`pagination` *	object	分页信息	Objeto pagination

Objeto temporary_cnab_file

字段	类型	描述	字符数
`temporary_cnab_file_key` *	uuidv4	临时 CNAB 文件唯一标识键，uuid v4 格式	36
`temporary_cnab_file_name` *	uuidv4	文件名	100
`temporary_cnab_file_status` *	string	临时 CNAB 文件状态	Enumeradores temporary_cnab_file_status
`occurrence_quantity` *	integer	文件中的记录数量	-
`created_at` *	string	文件在数据库中创建的时间戳，ISO Zulu 格式	20

Objeto pagination

字段	类型	描述	字符数
`current_page` *	integer	当前页码	-
`rows_per_page` *	integer	每页记录数	-

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`
403	BKS000005	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
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.
400	BKS000012	Bad Request	Invalid integer value for page or size query string parameters.	Valor inválido para parâmetros de página ou tamanho de página.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada

Request​

Path parameters​

Query parameters​

Enumeradores temporary_cnab_file_status​

Response​

Response Body Params​

Objeto temporary_cnab_file​

Objeto pagination​

Error Response​