get https://staging.api.decentro.tech/v3/banking/settlement_account_details
Overview
This API can be used by platforms to get all the settlement account details configured on Decentro.
Flow
Below is the flow for consuming this API
- For consumer URN, The settlement account number provided in the response are all settlement accounts added against a consumer URN
- For Virtual Account Number,The settlement account number provided in the response are all settlement accounts added against a virtual account number
Response parameter
| Parameters | Description |
|---|---|
| decentro_txn_id | A unique transaction ID from Decentro for the API request |
| api_status | Status of the API Request. |
| message | API status message. |
| response_key | |
| data | Object/ Data Block, the below parameters will be present inside this data block |
| virtual_account_number | The virtual account number against which the settlement account details are shown, Note: This parameter will be present only when the "virtual_account_number" is passed in the search params. |
| consumer_urn | The consumer URN against which the settlement account details are shown, Note: This parameter will be present only when the "consumer_urn" is passed in the search params. |
| page | The current page of the API response |
| total_pages | The total no. of pages present for the API request. |
| total_records | Total no. of settlement account details present for the API request. |
| limit | The total limit of records present per page |
| page_size | The total records present in the page |
| settlement_account_details | Object/ Data Block, the below parameters will be present inside this data block |
| settlement_account_urn | A URN created for every settlement account. The URN will contain the details of the settlement account. |
| name | The settlement account name |
| settlement_account_number | The settlement account number |
| settlement_account_ifsc | The settlement account IFSC |
| is_active | A boolean value to indicidate whether the settlement account is active or not |
| is_master_settlement_account | A boolean value to indicidate whether the settlement account is master or not. |
Response Keys
| Response Keys | Response Message |
|---|---|
| success_settlement_accounts_fetched_successfully | Settlement Account Details fetched successfully |
| error_missing_consumer_urn_and_virtual_account_number | Either Consumer URN or Virtual Account Number must be provided. Hint: consumer_urn (string) or virtual_account_number (string) |
| error_missing_page | Page cannot be null or empty. Hint: page (integer) |
| error_invalid_page | Page is not of type integer. Hint: page (integer) |
| error_invalid_consumer_urn_and_virtual_account_number | Provide either the Consumer URN or the Virtual Account Number. Hint: consumer_urn (string) or virtual_account_number (string) |
| error_invalid_consumer_urn | The provided Consumer URN does not match any records for the specified company. Hint: consumer_urn (string) |
| error_invalid_virtual_account_number | The provided Virtual Account Number does not match any records for the specified company. Hint: virtual_account_number (string) |
| error_invalid_limit | Limit is not of type integer. Hint: limit (integer) |