Listar arquivos retorno

info

Os arquivos disponibilizados nas URLs fornecidas na resposta desse endpoint seguem o padrão de Layout de Arquivo de Retorno com 400 posições da QI Tech. Segue link para download do manual: Layout de Cobrança - QI Tech versão 2.1.

Os arquivos retorno servem para conciliação. Nele, cada linha de Registro de Transação (Tipo 1) diz respeito a uma instrução (seja de emissão, prorrogação, abatimento etc.) que foi confirmada ou rejeitada pela CIP/Nuclea no dia anterior.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/discharge_files

MÉTODO

GET

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36

Query parameters

Campo	Tipo	Descrição	Caracteres
discharge_file_key	uuidv4	Chave única de identificação do arquivo retorno, no formato uuid v4	36
page	integer	Número da página	-
page_size	integer	Tamanho da página	-
from_date	string	Data inicial (formato "AAAA-MM-DD")	10
to_date	string	Data final (formato "AAAA-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

Campo	Tipo	Descrição	Caracteres
data	object array	Arquivos retorno	Objeto discharge_file
pagination	object	Informações de paginação	Objeto pagination

Objeto discharge_file

Campo	Tipo	Descrição	Caracteres
discharge_file_key	uuidv4	Chave única de identificação do arquivo retorno no formato uuid v4	36
discharge_file_name	string	Nome do arquivo retorno	-
discharge_file_url	string	URL do arquivo retorno	-
reference_date	string	Data de referencia do aquivo retorno no formato YYYY-MM-DD	10

Objeto pagination

Campo	Tipo	Descrição	Caracteres
current_page	integer	Página atual	-
rows_per_page	integer	Itens por página	-

Error Response

STATUS

4xx

Response Body: Error

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

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (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.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada
400	BKS000052	Bad Request	Invalid account status.	Status da conta inválido.