Scheduling single/multiple debit requests
To view error codes, click here
Scheduling single/multiple debit requests
To view error codes, click here
Getting started with Digio Rest Apis
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
This API is used to create schedule plan for a single UMRN
Mutual Fund
{
"umrn": "UMRN2984366445219389",
"amount": 2.0,
"settlement_date" : "2019-04-10",
"corporate_account_number" : "123456789",
"corporate_config_id" : "TSE180110115609336HGUGFNECH30001",
"destination_bank_id": "HDFC0000158",
"customer_account_number" : "01581000136321",
"customer_name" : "devesh",
"frequency" : "monthly"
"optional_attr" : {
"utr_number" : "",
"pg_bank_ref_number" : "",
"member_id" : "",
"client_id" : "",
"bank_code" : "",
"txn_type" : "",
"additional_date" : "",
"order_id" : "",
"credit_utility_code" : "",
"product_type" : "",
"mis_shared_with" : "",
"destination_bank_code": ""
}
}
Mandate UMRN created upon successful registration of Mandate
Date for Settlement in yyyy-mm-dd
Default:
(i) first_collection_date as provided in registered mandate
OR
(ii) current date
Corporate account number where debited amount from customer’s account is to be settled. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required. For Non Digio PA users, this is a mandatory attribute.
All numeric
Min len = 8 Max len = 18
For Digio PA users, easy to use config for custom settlement amount. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required.
âž” Either amount or amount_in_paise is mandatory
Either amount or amount_in_paise is mandatory
Optional. Passing the attribute is not required if the mandate already exists in the digio system, else error will be thrown.
Corporate config created from dashboard has below info and is auto populated during user authentication.
Utility Code
Service provider name
Sponsor bank name
Sponsor bank
Sponsor bank ifsc
Length = 32
âž” Optional, only applicable if mandate is not provided by Digio. Default: SAVINGS
Pass one from below
SAVINGS,
CURRENT,
CC,
SB_NRE,
SB_NRO,
OTHER
âž” Optional, only applicable if mandate is not provided by Digio. Name of the customer
âž” Optional, only applicable if mandate is not provided by Digio. Bank account number of customer
âž” Default: Corporate name
Allowed chars: a-zA-Z.0-9
The value provided in narration, will be reflected in the customer account statement.
Optional, only applicable if mandate is not provided by Digio. Valid IFSC or MICR Code
➔ To be used for Corporate’s reference should be unique for each debit request.
ex: umrn_1, umrn_2
Allowed chars: a-zA-Z.0-9_
Min len = 1 Max len = 30
Note : Please provide unique_key in the API call to avoid duplicate schedule/debit creation
Set value to assign it to a sub-user. Provide the email_id of registered sub_user. If it is provided then the debit details will be available in sub user login
âž” Only for Digio PA users, easy to use config for custom settlement amount. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required.
Min Items: 2 Max Items: 10 ⮕ [ Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required. ]
Bank Account Number
Amount to be settled in paise
âž” Pass any one allowed value
âž” Refers to the number of consecutive debits to be undertaken
Note: payment_count has to be one if frequency is ONETIME
Please refer below for the additional attributes, that should only be passed by Mutual Fund use case customers
âž” Pass this attribute as blank. This will be populated by Sponsor Bank
Unique number generated for funds transferred in ICCL's Account
âž” Unique reference number provided by the member for payment to be collected for a unique client. Please pass the SIP Registration Number here, which will be sent to ICCLALPHA NUM, No Special char,
âž” Member ID for whom the PA/ Bank is uploading the file NUM, No Special char,
âž” UCC for the said Client. ALPHA NUM, No Special char,
âž” For YES Bank as sponsor bank, Pass RCY. Will be provided by BSE/ICCL to the PA/Bank and it will be common for transactions uploaded by the specific PA/Bank. ALPHA, No Special char
âž” L : Lump Sum S : SIP
Pass this attribute as blank. This will be populated by Sponsor Bank. Date in DD-MM-YYYY format In case of Lump Sum and SIP First Order, the date reported can be repeated. In case of running SIP Date of trigger of SIP will be reported
âž” Pass the Order Number for this SIP order Will be sent by Member to PA/Bank to ICCL. ALPHA NUM, No Special char
âž” UTILITY CODE of Clearing House / AMC where Funds will be Credited ALPHA NUM, No Special char. For ICCL, please pass: YESB00709000028661
âž” MUT : Mutual Funds (will create file as per new SEBI and Exchanges guidelines) For Non MF use cases, please DO NOT pass optional_attr and its associated attributes
âž” ICCL: BSE Clearing NSCCL: NSE Clearing AMC: AMC
âž” Pass this attribute as blank. This will be populated by Sponsor Bank
Unique ID of created plan
Current status of created plan
Details of transaction scheduled ahead
âž” Current state of the transaction
Timestamp of presentation
Date of settlement for the given transaction
Details of customer
Name of the customer
âž” Type of account of the customer
IFSC code of the bank
Masked account number of the customer
Details of corporate
Name of the corporate
Utility code registered for the corporate
Reference number against the corporate
IFSC code of the sponsor bank
Bank code for sponsor bank
Masked account number of the corporate
Details of partner bank
Name of the partner bank
Email of the partner bank
Further details of schedule plan created
Date of the first settlement
Date of the next scheduled settlement
Total number of payments to be made
âž” Number of payments already made
Date when the next payment should be presented
Date when the last payment was presented
Date of the last presented settlement
âž” Frequency of subscription payments
âž” Number of days before which the settlement should be presented
Narration or description of the payment schedule
Amount to be paid in paise
Transaction reference
Type of the product for which the schedule is created
Date when the schedule ended
Mandate ID associated with the payment schedule
Client reference ID for identification
Sub user details, if the request was containing sub-user identifier.
Sub-user id
Identifier used for sub-user, , this is generally emailID or mobile number
âž” Type of identifier
Sub-user's email id if registered.
Sub-user's mobile number
Timestamp of plan creation
Name of the sponsor bank
Details about the exception. Usually contains the exception id for reference.
Error code
Description of the error
Custom errors
Getting started with Digio Rest Apis
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
This API is used to create schedule plan for a multiple UMRN. NOTE: Max Limit: 200 entries per request. Each entry has the same structure as the 1st API.
{
"requests" : [
{
"umrn" : "UMRN2984366445219389",
"amount" : 2.0,
"settlement_date" : "2019-04-10",
"corporate_account_number" : "123456789",
"corporate_config_id" : "TSE180110115609336HGUGFNECH30001",
"destination_bank_id": "HDFC0000158",
"unique_key": "LAN_EMI_1",
"narration": "TW Loan EMI",
"customer_account_number" : "01581000136321",
"customer_name" : "devesh",
"frequency" : "monthly"
},
{ <entry-2> },
{ <entry-3> }
]
}
Mandate UMRN created upon successful registration of Mandate
Date for Settlement in yyyy-mm-dd
Default:
(i) first_collection_date as provided in registered mandate
OR
(ii) current date
Corporate account number where debited amount from customer’s account is to be settled. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required. For Non Digio PA users, this is a mandatory attribute.
All numeric
Min len = 8 Max len = 18
For Digio PA users, easy to use config for custom settlement amount. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required.
âž” Either amount or amount_in_paise is mandatory
Either amount or amount_in_paise is mandatory
Optional. Passing the attribute is not required if the mandate already exists in the digio system, else error will be thrown.
Corporate config created from dashboard has below info and is auto populated during user authentication.
Utility Code
Service provider name
Sponsor bank name
Sponsor bank
Sponsor bank ifsc
Length = 32
âž” Optional, only applicable if mandate is not provided by Digio. Default: SAVINGS
Pass one from below
SAVINGS,
CURRENT,
CC,
SB_NRE,
SB_NRO,
OTHER
âž” Optional, only applicable if mandate is not provided by Digio. Name of the customer
âž” Optional, only applicable if mandate is not provided by Digio. Bank account number of customer
âž” Default: Corporate name
Allowed chars: a-zA-Z.0-9
The value provided in narration, will be reflected in the customer account statement.
Optional, only applicable if mandate is not provided by Digio. Valid IFSC or MICR Code
➔ To be used for Corporate’s reference should be unique for each debit request.
ex: umrn_1, umrn_2
Allowed chars: a-zA-Z.0-9_
Min len = 1 Max len = 30
Note : Please provide unique_key in the API call to avoid duplicate schedule/debit creation
Set value to assign it to a sub-user. Provide the email_id of registered sub_user. If it is provided then the debit details will be available in sub user login
âž” Only for Digio PA users, easy to use config for custom settlement amount. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required.
Min Items: 2 Max Items: 10 ⮕ [ Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required. ]
Bank Account Number
Amount to be settled in paise
âž” Pass any one allowed value
âž” Refers to the number of consecutive debits to be undertaken
Note: payment_count has to be one if frequency is ONETIME
Please refer below for the additional attributes, that should only be passed by Mutual Fund use case customers
âž” Pass this attribute as blank. This will be populated by Sponsor Bank
Unique number generated for funds transferred in ICCL's Account
âž” Unique reference number provided by the member for payment to be collected for a unique client. Please pass the SIP Registration Number here, which will be sent to ICCLALPHA NUM, No Special char,
âž” Member ID for whom the PA/ Bank is uploading the file NUM, No Special char,
âž” UCC for the said Client. ALPHA NUM, No Special char,
âž” For YES Bank as sponsor bank, Pass RCY. Will be provided by BSE/ICCL to the PA/Bank and it will be common for transactions uploaded by the specific PA/Bank. ALPHA, No Special char
âž” L : Lump Sum S : SIP
Pass this attribute as blank. This will be populated by Sponsor Bank. Date in DD-MM-YYYY format In case of Lump Sum and SIP First Order, the date reported can be repeated. In case of running SIP Date of trigger of SIP will be reported
âž” Pass the Order Number for this SIP order Will be sent by Member to PA/Bank to ICCL. ALPHA NUM, No Special char
âž” UTILITY CODE of Clearing House / AMC where Funds will be Credited ALPHA NUM, No Special char. For ICCL, please pass: YESB00709000028661
âž” MUT : Mutual Funds (will create file as per new SEBI and Exchanges guidelines) For Non MF use cases, please DO NOT pass optional_attr and its associated attributes
âž” ICCL: BSE Clearing NSCCL: NSE Clearing AMC: AMC
âž” Pass this attribute as blank. This will be populated by Sponsor Bank
Details about the exception. Usually contains the exception id for reference.
Error code
Description of the error
Custom errors
Was this page helpful?