Live demo of agent247 on Digio's docs — click the orange button at the bottom right to start.

Scheduling single/multiple debit requests

To view error codes, click here

Digio Apis

Getting started with Digio Rest Apis

API SERVER

SELECTED: https://api.digio.in
AUTHENTICATION
No API key applied
General ⦂

Create presentation for a single UMRN

post {BASE_URL}/v3/client/nach_debit/scheduled/register

This API is used to create schedule plan for a single UMRN

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
REQUEST BODY * application/json

Mutual Fund

object
Single line description
Field
Type
Description
umrn *
string

Mandate UMRN created upon successful registration of Mandate

settlement_date
date-time

Date for Settlement in yyyy-mm-dd

Default:
(i) first_collection_date as provided in registered mandate
OR
(ii) current date

corporate_account_number *
string

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

settlement_config_profile_id
string

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.

amount_in_paise
integer

âž” Either amount or amount_in_paise is mandatory

Constraints: Min 1
amount
string

Either amount or amount_in_paise is mandatory

corporate_config_id
string

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

destination_account_type
enum

âž” Optional, only applicable if mandate is not provided by Digio. Default: SAVINGS

Pass one from below
SAVINGS,
CURRENT,
CC,
SB_NRE,
SB_NRO,
OTHER

Allowed: savings┃current┃cc┃sb_nre┃sb_nro┃other
customer_name
string

âž” Optional, only applicable if mandate is not provided by Digio. Name of the customer

Constraints: 1 to 40 chars
Pattern: ^[0-9A-Za-z]{1,}[0-9A-Za-z\s.']{0,}$
customer_account_number
string

âž” Optional, only applicable if mandate is not provided by Digio. Bank account number of customer

Constraints: 8 to 18 chars
narration
string

âž” Default: Corporate name
Allowed chars: a-zA-Z.0-9
The value provided in narration, will be reflected in the customer account statement.

Constraints: 1 to 20 chars
Pattern: ^[0-9A-Za-z\& .]{0,}$
destination_bank_id
string

Optional, only applicable if mandate is not provided by Digio. Valid IFSC or MICR Code

unique_key
string

➔ 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

Constraints: 1 to 30 chars
Pattern: ^[A-Za-z0-9-_]*$
sub_user_identifier
string

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

- split_settlement_info
array of object

âž” 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. ]

settlement_account_number
string

Bank Account Number

split_amount_in_paise *
integer

Amount to be settled in paise

frequency *
enum

âž” Pass any one allowed value

Default: ONETIME
Allowed: onetime┃adhoc┃intraday┃daily┃weekly┃monthly┃quarterly┃semiannually┃yearly┃bimonthly
payment_count
integer

âž” Refers to the number of consecutive debits to be undertaken
Note: payment_count has to be one if frequency is ONETIME

Constraints: Min 1
Default: 1
- optional_attr
object

Please refer below for the additional attributes, that should only be passed by Mutual Fund use case customers

utr_number *
string

âž” Pass this attribute as blank. This will be populated by Sponsor Bank
Unique number generated for funds transferred in ICCL's Account

Pattern: ^$
pg_bank_ref_number *
string

âž” 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,

Constraints: Max 25 chars
Pattern: ^[A-Za-z0-9]*$
member_id *
string

âž” Member ID for whom the PA/ Bank is uploading the file NUM, No Special char,

Constraints: Max 5 chars
Pattern: ^[0-9]+$
client_id *
string

âž” UCC for the said Client. ALPHA NUM, No Special char,

Pattern: ^[A-Za-z0-9]*$
bank_code *
string

âž” 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

Constraints: Max 3 chars
Pattern: ^[A-Za-z0-9]*$
txn_type *
enum

âž” L : Lump Sum S : SIP

Allowed: L┃S
additional_date
date-time

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

order_id
string

âž” Pass the Order Number for this SIP order Will be sent by Member to PA/Bank to ICCL. ALPHA NUM, No Special char

Constraints: Max 30 chars
Pattern: ^[A-Za-z0-9]*$
credit_utility_code *
string

âž” UTILITY CODE of Clearing House / AMC where Funds will be Credited ALPHA NUM, No Special char. For ICCL, please pass: YESB00709000028661

Pattern: ^[A-Za-z0-9]*$
product_type *
enum

âž” 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

Allowed: MUT
mis_shared_with *
enum

âž” ICCL: BSE Clearing NSCCL: NSE Clearing AMC: AMC

Allowed: ICCL┃NSCCL┃AMC
destination_bank_code
string

âž” Pass this attribute as blank. This will be populated by Sponsor Bank

Pattern: ^$
RESPONSE
application/json
object
Single line description
Field
Type
Description
id
string

Unique ID of created plan

status
string

Current status of created plan

- upcoming_transaction
object

Details of transaction scheduled ahead

state
enum

âž” Current state of the transaction

Allowed: SCHEDULED┃SKIPPED┃PROCESSING┃DELAYED┃FAILED┃AUTHENTICATED┃SUCCESS
present_at
date-time

Timestamp of presentation

scheduled_settlement_date
date-time

Date of settlement for the given transaction

- customer
object

Details of customer

name
string

Name of the customer

destination_account_type
enum

âž” Type of account of the customer

Default: SAVINGS
Allowed: SAVINGS┃CURRENT┃OTHER
destination_ifsc
string

IFSC code of the bank

user_account_number
string

Masked account number of the customer

- corporate
object

Details of corporate

name
string

Name of the corporate

utility_code
string

Utility code registered for the corporate

corporate_reference
string

Reference number against the corporate

sponsor_ifsc
string

IFSC code of the sponsor bank

sponsor_bank_code
string

Bank code for sponsor bank

corporate_account_number
string

Masked account number of the corporate

- partner
object

Details of partner bank

name
string

Name of the partner bank

identifier
string

Email of the partner bank

- details
object

Further details of schedule plan created

first_proposed_settlement_date
date-time

Date of the first settlement

next_scheduled_settlement_date
date-time

Date of the next scheduled settlement

payment_count
integer

Total number of payments to be made

paid_count
integer

âž” Number of payments already made

Default: 0
next_present_at
date-time

Date when the next payment should be presented

last_presented_at
date-time

Date when the last payment was presented

last_presented_settlement_date
date-time

Date of the last presented settlement

frequency
enum

âž” Frequency of subscription payments

Allowed: onetime┃adhoc┃intraday┃daily┃weekly┃monthly┃quarterly┃semiannually┃yearly┃bimonthly
present_settlement_before_days
integer

âž” Number of days before which the settlement should be presented

Default: 1
narration
string

Narration or description of the payment schedule

amount_in_paise
integer

Amount to be paid in paise

txn_reference
string

Transaction reference

product_type
string

Type of the product for which the schedule is created

ended_at
date-time

Date when the schedule ended

mandate_id
string

Mandate ID associated with the payment schedule

client_ref_id
string

Client reference ID for identification

- sub_user
object

Sub user details, if the request was containing sub-user identifier.

id
string

Sub-user id

identifier_value
string

Identifier used for sub-user, , this is generally emailID or mobile number

identifier
enum

âž” Type of identifier

Allowed: EMAIL┃MOBILE
email_id
string

Sub-user's email id if registered.

mobile
string

Sub-user's mobile number

created_at
date-time

Timestamp of plan creation

sponsor_bank_name
string

Name of the sponsor bank

application/json
object
Single line description
Field
Type
Description
details
string

Details about the exception. Usually contains the exception id for reference.

code
string

Error code

message
string

Description of the error

errors
string

Custom errors

Digio Apis

Getting started with Digio Rest Apis

API SERVER

SELECTED: https://api.digio.in
AUTHENTICATION
No API key applied
General ⦂

Create presentation for a multiple UMRNs

post {BASE_URL}/v3/client/nach_debit/scheduled/register_multiple

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.

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
REQUEST BODY application/json
object
Single line description
Field
Type
Description
- requests
array of object
umrn *
string

Mandate UMRN created upon successful registration of Mandate

settlement_date
date-time

Date for Settlement in yyyy-mm-dd

Default:
(i) first_collection_date as provided in registered mandate
OR
(ii) current date

corporate_account_number *
string

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

settlement_config_profile_id
string

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.

amount_in_paise
integer

âž” Either amount or amount_in_paise is mandatory

Constraints: Min 1
amount
string

Either amount or amount_in_paise is mandatory

corporate_config_id
string

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

destination_account_type
enum

âž” Optional, only applicable if mandate is not provided by Digio. Default: SAVINGS

Pass one from below
SAVINGS,
CURRENT,
CC,
SB_NRE,
SB_NRO,
OTHER

Allowed: savings┃current┃cc┃sb_nre┃sb_nro┃other
customer_name
string

âž” Optional, only applicable if mandate is not provided by Digio. Name of the customer

Constraints: 1 to 40 chars
Pattern: ^[0-9A-Za-z]{1,}[0-9A-Za-z\s.']{0,}$
customer_account_number
string

âž” Optional, only applicable if mandate is not provided by Digio. Bank account number of customer

Constraints: 8 to 18 chars
narration
string

âž” Default: Corporate name
Allowed chars: a-zA-Z.0-9
The value provided in narration, will be reflected in the customer account statement.

Constraints: 1 to 20 chars
Pattern: ^[0-9A-Za-z\& .]{0,}$
destination_bank_id
string

Optional, only applicable if mandate is not provided by Digio. Valid IFSC or MICR Code

unique_key
string

➔ 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

Constraints: 1 to 30 chars
Pattern: ^[A-Za-z0-9-_]*$
sub_user_identifier
string

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

- split_settlement_info
array of object

âž” 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. ]

settlement_account_number
string

Bank Account Number

split_amount_in_paise *
integer

Amount to be settled in paise

frequency *
enum

âž” Pass any one allowed value

Default: ONETIME
Allowed: onetime┃adhoc┃intraday┃daily┃weekly┃monthly┃quarterly┃semiannually┃yearly┃bimonthly
payment_count
integer

âž” Refers to the number of consecutive debits to be undertaken
Note: payment_count has to be one if frequency is ONETIME

Constraints: Min 1
Default: 1
- optional_attr
object

Please refer below for the additional attributes, that should only be passed by Mutual Fund use case customers

utr_number *
string

âž” Pass this attribute as blank. This will be populated by Sponsor Bank
Unique number generated for funds transferred in ICCL's Account

Pattern: ^$
pg_bank_ref_number *
string

âž” 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,

Constraints: Max 25 chars
Pattern: ^[A-Za-z0-9]*$
member_id *
string

âž” Member ID for whom the PA/ Bank is uploading the file NUM, No Special char,

Constraints: Max 5 chars
Pattern: ^[0-9]+$
client_id *
string

âž” UCC for the said Client. ALPHA NUM, No Special char,

Pattern: ^[A-Za-z0-9]*$
bank_code *
string

âž” 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

Constraints: Max 3 chars
Pattern: ^[A-Za-z0-9]*$
txn_type *
enum

âž” L : Lump Sum S : SIP

Allowed: L┃S
additional_date
date-time

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

order_id
string

âž” Pass the Order Number for this SIP order Will be sent by Member to PA/Bank to ICCL. ALPHA NUM, No Special char

Constraints: Max 30 chars
Pattern: ^[A-Za-z0-9]*$
credit_utility_code *
string

âž” UTILITY CODE of Clearing House / AMC where Funds will be Credited ALPHA NUM, No Special char. For ICCL, please pass: YESB00709000028661

Pattern: ^[A-Za-z0-9]*$
product_type *
enum

âž” 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

Allowed: MUT
mis_shared_with *
enum

âž” ICCL: BSE Clearing NSCCL: NSE Clearing AMC: AMC

Allowed: ICCL┃NSCCL┃AMC
destination_bank_code
string

âž” Pass this attribute as blank. This will be populated by Sponsor Bank

Pattern: ^$
RESPONSE
application/json
object
Single line description
Field
Type
Description
empty
boolean
application/json
object
Single line description
Field
Type
Description
details
string

Details about the exception. Usually contains the exception id for reference.

code
string

Error code

message
string

Description of the error

errors
string

Custom errors

Was this page helpful?