get
https://api.caas.staging.bancocdc.com.br/operation/product
The retrieve route is responsible for fetching all available operational products.
Attention point:
Below is an explanation of the fields related to credit policy:
Credit Policy
| Parameter | Description |
|---|---|
| name | Product name |
| model | Calculation model, 1- Rate, 3- Advance, 4- FGTS |
| guarantor | Need for a guarantor when signing the contract |
| disbursement_third_parties | Possibility to pay the credit to a third party account |
| disbursement_multiple_accounts | Possibility to pay credit on multiple accounts |
| negative_customer | Accepts negative customers |
| percentage_customer_income | Percentage of the customer's income in relation to the installment |
| minimum_installments_amount | Minimum installment amount |
| maximum_installments_amount | Maximum installment amount |
| minimum_operation_amount | Minimum operation amount |
| maximum_operating_amount | Maximum operation amount |
| time_admission_company | Customer admission time, when necessary |
| periodicity | Credit installment term |
| rate | credit rate |
Response
| Http Code | Return Code | Message |
|---|---|---|
| 200 | 200-01 | Success. |
| 400 | 400-01 | Something unexpected happened. |
| 400 | 400-09 | There are no results for the query. |
| 401 | 401-05 | Unauthorized or token invalid. |
| 429 | 429-01 | Too many requests |
Response Parameters
| Parameter | Format | Description |
|---|---|---|
| request_code | string | Code of the request made |
| return | boolean | Indicates if the request was successful |
| return_code | string | Return code of the request |
| message | string | Message indicating the reason for the response |
| data | array | Array containing information about the products |
| data[].code | string | Code associated with the product |
| data[].name | string | Name of the product |
| data[].model | string | Model of the operational product (e.g., "1" for model 1) |
| data[].guarantor | string | Indicates if the operational product requires a guarantor (Y/N) |
| data[].disbursement_third_parties | string | Indicates if the operational product allows disbursement to third parties (Y/N) |
| data[].disbursement_multiple_accounts | string | Indicates if the operational product allows disbursement to multiple accounts (Y/N) |
| data[].negative_customer | string | Indicates if the operational product allows negative customers (Y/N) |
| data[].percentage_customer_income | string | Percentage of customer income required for the operational product |
| data[].minimum_installments_amount | string | Minimum amount allowed for installments |
| data[].maximum_installments_amount | string | Maximum amount allowed for installments |
| data[].minimum_operation_amount | string | Minimum amount allowed for operations |
| data[].maximum_operating_amount | string | Maximum amount allowed for operations |
| data[].time_admission_company | string | Time of admission to the company required for the operational product |
| data[].periodicity | object | Object containing information about the periodicity of the product |
| data[].periodicity.code | number | Code associated with the periodicity (e.g., 1 for fixed) |
| data[].periodicity.model | string | Model of the periodicity (e.g., "range" or "fixed") |
| data[].periodicity.minimum | string | Minimum value for the periodicity |
| data[].periodicity.maximum | string | Maximum value for the periodicity |