Bankslip Configurations Retrieval

---

List bankslip configurations

Returns a paginated list of the bankslip configurations of a bankslip profile within a fund class. The fund must belong to the authenticated manager or be linked to the authenticated consultant.

Available on

Profile	Host	Required permission
Manager	manager-api	Read
Consultant	consultant-api	Granted by the integration team

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip_configurations

METHOD

GET

Path Params

Parameter	Description
fund_class_key	Key of the fund class. Returns 404 (BSC000006) if it doesn't exist.
bankslip_profile_key	Key of the bankslip profile, which must belong to the fund class. Returns 404 (BSC000007) if not found.

Query Params

All parameters are optional.

Parameter	Type	Description
issuer_type	string	Filters by issuer type (see Issuer Type). An unknown value returns the BSC000023 error.
limit	int	Value between 0 and 30 with the number of items per page. Default: 10.
page	int	Zero-based page number. Default: 0.

When is_last_page is false, request the next page to retrieve the remaining results.

Response

Response Body

Response Body

{
    "data": [
        {
            "bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
            "bankslip_profile": {
                "bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "bankslip_provider": "qi_scd",
                "additional_information": {
                    "requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
                },
                "internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
                "fund_class": {
                    "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                    "document_number": "00.000.000/0001-01",
                    "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                    "manager": {
                        "name": "GESTÃO DE RECURSOS",
                        "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                        "document_number": "00.100.100/0001-00"
                    }
                }
            },
            "bankslip_issuer_type": "manager",
            "delay": 0,
            "our_number_range": {
                "our_number_range_initial": 1,
                "our_number_range_final": 99999
            }
        },
        {
            "bankslip_configuration_key": "9c47d1a8-3f2e-4b6d-8a1c-5e7f9b3d2c80",
            "bankslip_profile": {
                "bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "bankslip_provider": "qi_scd",
                "additional_information": {
                    "requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
                },
                "internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
                "fund_class": {
                    "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                    "document_number": "00.000.000/0001-01",
                    "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                    "manager": {
                        "name": "GESTÃO DE RECURSOS",
                        "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                        "document_number": "00.100.100/0001-00"
                    }
                }
            },
            "bankslip_issuer_type": "internal",
            "delay": 1
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true,
    "elapsed_time_ms": 12.34
}

Paginated Object

Field	Type	Description
data	array	List of Bankslip Configuration objects
limit	int	Limit of objects retrieved per page
page	int	Number of the retrieved page
is_last_page	boolean	Indicates whether the retrieved page is the last one
elapsed_time_ms	number	Server-side query execution time, in milliseconds

Bankslip Configuration

Field	Type	Description
bankslip_configuration_key	string	Unique identifier of the bankslip configuration.
bankslip_profile	object	Associated bankslip profile (see Bankslip Profile).
bankslip_issuer_type	string	Bankslip issuer type (see Issuer Type).
delay	int	Delay configured for bankslip issuance.
our_number_range	object	"Nosso número" range assigned to the configuration (see Our Number Range). Only present when the configuration has a range assigned.

Our Number Range

Field	Type	Description
our_number_range_initial	int	Start of the "nosso número" range.
our_number_range_final	int	End of the "nosso número" range.

Issuer Type

Enumerator	Description
internal	Internal
manager	Manager
consultant	Consultant

Errors

Status	Code	When it happens
404	BSC000007	The bankslip profile does not exist in this fund.
400	BSC000023	issuer_type with an unknown value.
404	BSC000006	The fund_class_key does not exist.
403	BSC000036	The fund does not belong to your profile.

Authentication, permission and host errors: see API errors.