List discharge files

info

The files provided in the URLs returned by this endpoint follow the QI Tech Return File Layout standard with 400 positions. Download the manual here: Layout de Cobrança - QI Tech versão 2.1.

Discharge files are used for reconciliation. Each Transaction Record line (Type 1) refers to an instruction (whether for issuance, extension, discount, etc.) that was confirmed or rejected by CIP/Nuclea on the previous day.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/discharge_files

METHOD

GET

Path parameters

Field	Type	Description	Characters
`account_key`	uuidv4	Unique account identification key	36
`requester_profile_key`	uuidv4	Unique wallet identification key, in uuid v4 format	36

Query parameters

Field	Type	Description	Characters
`discharge_file_key`	uuidv4	Unique discharge file identification key, in uuid v4 format	36
`page`	integer	Page number	-
`page_size`	integer	Page size	-
`from_date`	string	Start date (format "YYYY-MM-DD")	10
`to_date`	string	End date (format "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

Field	Type	Description	Characters
`data`	object array	Discharge files	discharge_file object
`pagination`	object	Pagination information	pagination object

discharge_file object

Field	Type	Description	Characters
`discharge_file_key`	uuidv4	Unique discharge file identification key in uuid v4 format	36
`discharge_file_name`	string	Discharge file name	-
`discharge_file_url`	string	Discharge file URL	-
`reference_date`	string	Discharge file reference date in YYYY-MM-DD format	10

pagination object

Field	Type	Description	Characters
`current_page`	integer	Current page	-
`rows_per_page`	integer	Items per page	-

Error Response

STATUS

4xx

Response Body: Error

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

HTTP Code `status`	QI Code `code`	Title `title`	Description (eng) `description`	Description (pt-br) `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​

discharge_file object​

pagination object​

Error Response​