列出返回文件

信息

响应中提供的 URL 中的文件遵循 QI Tech 400 位返回文件布局标准。以下是手册下载链接：催收布局 - QI Tech 版本 2.1

返回文件用于对账。文件中，每行交易记录（类型 1）对应前一天 CIP/Nuclea 确认或拒绝的一条指令（无论是发行、延期、减免等类型）。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/discharge_files

MÉTODO

GET

Path parameters

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

Query parameters

字段	类型	描述	字符数
`discharge_file_key`	uuidv4	返回文件唯一标识键，uuid v4 格式	36
`page`	integer	页码	-
`page_size`	integer	每页大小	-
`from_date`	string	起始日期（格式"YYYY-MM-DD"）	10
`to_date`	string	结束日期（格式"YYYY-MM-DD"）	10

Response

STATUS

200

Response Body

{
    "data": [
        {
            "discharge_file_key": "f1a8fe59-29cd-49e5-8d18-55194869b45c",
            "discharge_file_name": "CB15102401.RET",
            "discharge_file_url": "https://storage.googleapis.com/local-bank-slip-api/2024/61a746ca-05bf-429d-99c3-3fba0f9fbea7/329-20-7336-3073959/discharge/CB15102401.RET",
            "reference_date": "2024-10-15"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}

Response Body Params

字段	类型	描述	字符数
`data`	object array	返回文件	Objeto discharge_file
`pagination`	object	分页信息	Objeto pagination

Objeto discharge_file

字段	类型	描述	字符数
`discharge_file_key`	uuidv4	返回文件唯一标识键，uuid v4 格式	36
`discharge_file_name`	string	返回文件名称	-
`discharge_file_url`	string	返回文件 URL	-
`reference_date`	string	返回文件参考日期，格式 YYYY-MM-DD	10

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`
400	QIT000001	Bad Request	Schema Error	Schema Inválido
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	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
400	BKS000052	Bad Request	Invalid account status.	Status da conta inválido.

Request​

Path parameters​

Query parameters​

Response​

Response Body Params​

Objeto discharge_file​

Objeto pagination​

Error Response​