Query return file

Warning

To ensure that the return file for the current day has updated information, verify that the day's information has been reconciled through polling as shown in Return file reconciliation routine

Request

ENDPOINT

/bank_slip/requester_profile/REQUESTER_PROFILE_CODE/cnab_files

METHOD

GET

Path params

Field	Type	Description	Characters
requester_profile_code *	string	Collection portfolio code.	10

Query params

Field	Type	Description	Characters
cnab_type *	enum	File Type	Enumerators
from *	string	Start of the period to be analyzed.	10
to *	string	End of the period to be analyzed.	10

Enumerators cnab_type

Field	Description
requester_discharge	Return file

Response

STATUS

200

Response Body

{
  "data": [
    {
      "cnab_key": "47361262-0853-4c51-9c2a-5284e0d8a5e1",
      "company_code": null,
      "created_at": "2020-05-06T11:04:25",
      "downloads": [],
      "file_size": "None",
      "filename": "CNAB.RET",
      "line_length": "400",
      "remitter_key": "ab871cc8-8369-4b72-95f1-b074b30c7208",
      "requester_profile_code": "329-01-0001-0000002",
      "type": {
        "created_at": "2019-03-12T12:59:32",
        "enumerator": "requester_discharge",
        "translation_path": "bank_slip.CNABFileType.requester_discharge"
      },
      "url": "https://linkparadownload.com/CNAB.RET",
      "version": "11"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 100,
    "total_pages": 1,
    "total_rows": 1
  }
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}