Create Debit RequestNEW

Scheduling single/multiple debit requests

To view error codes, click here

Create presentation for a single UMRN

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

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

REQUEST

REQUEST BODY application/json

Field

Type

Description

umrn *

string

Mandate UMRN created upon successful registration of Mandate

settlement_date

date-time

Date for Settlement in yyyy-mm-dd hh:mm:ss

Default: (i) first_collection_date as provided in registered mandate OR (ii) current date Note : Settlement Date should be more than 26 hours from current time

corporate_account_number

string

➔ Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required. All numeric

Constraints: 8 to 18 chars

settlement_config_profile_id

string

Config of settlement, if already predefined. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required.

amount_in_paise

integer

Either of amount or amount_in_paise is mandatory

amount

number

Either of amount or amount_in_paise is mandatory.

narration

string

➔ Default: Enterprise name

Constraints: 1 to 20 chars

unique_key

string

➔ To be used for Corporate’s reference. Default: _ ex: _1, 2 Allowed chars: a-zA-Z.0-9 Note : It should be unique for each created debit.

Constraints: 1 to 30 chars

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

sub_user_identifier

string

Set value to assign it to a sub-user

- split_settlement_info

array of object

➔ 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

➔

Default: ONETIME

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

payment_count

integer

➔ Should be non-negative and >= 1. payment_count has to be one if frequency is ONETIME

Default: 1

- optional_attr

object

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

member_id *

string

Member ID for whom the PA/ Bank is uploading the file

client_id

string

UCC for the said Client.

pg_bank_ref_number

string

Unique reference number provided by the member for payment to be collected for a unique client.

order_id

string

➔ Pass the Order Number for this SIP order

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

txn_type

string

Type of transaction

- upi_mandate_extended_detail

object

string

umrn

string

ownerId

string

customerRefNumber

string

customerVpa

string

customerName

string

schemeRefNumber

string

partnerBank

enum

➔

Allowed: KOTAK┃YESB┃JUSPAY_KOTAK┃MGS_YESB

frequency

enum

➔

Allowed: ADHO┃INDA┃DAIL┃WEEK┃MNTH┃QURT┃MIAN┃YEAR┃ONETIME┃BIMN

corporateConfigId

string

status

enum

➔

Allowed: authenticated┃register_failed┃register_success┃paused┃revoke_initiated┃cancelled┃expired┃revoked

mandateStartDate

date-time

mandateEndDate

date-time

amount

number

amountType

enum

➔

Allowed: fixed┃maximum

digioEnachId

string

identifier

string

sponsorBankCode

enum

➔

Allowed: KOTAK┃YESB┃JUSPAY_KOTAK┃MGS_YESB

authenticationTime

date-time

narration

string

destinationBankIfsc

string

mandateRequestId

string

serviceProviderName

string

statusUpdatedAt

date-time

customerAccountNumber

string

customerAccountType

enum

➔

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

merchantCategoryCode

string

subUserId

string

RESPONSE

application/json

Field

Type

Description

string

Unique identifier for the UPI scheduled plan

umrn

string

Unique Mandate Reference Number for the scheduled plan

status

enum

➔ Current status of the scheduled payment

Allowed: ACTIVE┃CANCELLED┃PAUSED┃COMPLETED

- last_transaction

object

List of all transactions for the specific UPI schedule plan

string

Unique identifier for the transaction

umrn

string

UMRN associated with the transaction

state

enum

➔ State of the transaction

Allowed: scheduled┃skipped┃notified┃processing┃delayed┃failed┃authenticated┃success

created_at

date-time

Creation timestamp of the transaction

updated_at

date-time

Update timestamp of the transaction

status_updated_at

date-time

Timestamp when the transaction status was last updated

- customer

object

name

string

Name of the customer

identifier

string

Unique ID of the customer

- details

object

Detailed information about the UPI transaction

status

enum

➔ Status of the NACH payment transaction

Allowed: new┃ready_to_send┃skipped┃notify_initiated┃notified┃ready_to_debit┃debit_sequenced┃cancelled┃approved┃debit_initiated┃submitted_to_bank┃digio_technical_error┃accepted_spo_bank┃reject_spo_bank┃payment_delayed┃payment_authenticated┃payment_failed┃payment_success

amount

number

Transaction amount in standard currency units

amount_in_paise

integer

Transaction amount in the smallest currency units (e.g., paise)

sponsor_bank_id

string

Identifier for the sponsor bank

ready_to_process_at

date-time

Timestamp indicating when the transaction is ready to be processed

failure_code

string

Code indicating the reason for transaction failure, if applicable

failure_reason

string

Description of the reason for transaction failure, if applicable

customer_vpa

string

Virtual Payment Address of the customer, if applicable

type

enum

➔ Type of the transaction

Allowed: nach_debit┃upi┃payment_link┃upi_debit

txn_ref

string

Reference number for the transaction

utr

string

Unique Transaction Reference number for the transaction

settlement_desc

string

Description of the settlement

- settlement_details

object

settlement_bank_account_name

string

Name of the settlement bank account

total_amount

number

Total amount to be settled

tax1

number

First tax amount deducted from the settlement

tax2

number

Second tax amount deducted from the settlement

tax3

number

Third tax amount deducted from the settlement

fee1

number

First fee amount deducted from the settlement

fee2

number

Second fee amount deducted from the settlement

final_amount

number

Final amount after taxes and fees have been deducted

status

enum

➔ Status of the external settlement

Allowed: scheduled┃settle_success

consolidation_id

string

Consolidation identifier for the settlement

settlement_bank_txn_ref

string

Bank transaction reference for the settlement

account_number

string

Account number associated with the settlement

digio_utr

string

Digio's unique transaction reference number

settlement_date

date-time

Date of settlement for the transaction

parent_transaction_id

string

Identifier of the parent transaction, if any

- settlement_transaction_details

array of object

List of details for each settlement transaction

txn_id

string

Transaction ID of the debit transaction

amount_in_paise

integer

Amount in paise of the debit transaction

account_number

string

Account number associated with the transaction

settlement_utr_number

string

Unique Reference Number for the settlement

settlement_date

date-time

Date and time when the settlement was processed

- upcoming_transaction

object

List of all transactions for the specific UPI schedule plan

string

Unique identifier for the transaction

umrn

string

UMRN associated with the transaction

state

enum

➔ State of the transaction

Allowed: scheduled┃skipped┃notified┃processing┃delayed┃failed┃authenticated┃success

created_at

date-time

Creation timestamp of the transaction

updated_at

date-time

Update timestamp of the transaction

status_updated_at

date-time

Timestamp when the transaction status was last updated

- customer

object

name

string

Name of the customer

identifier

string

Unique ID of the customer

- details

object

Detailed information about the UPI transaction

status

enum

➔ Status of the NACH payment transaction

amount

number

Transaction amount in standard currency units

amount_in_paise

integer

Transaction amount in the smallest currency units (e.g., paise)

sponsor_bank_id

string

Identifier for the sponsor bank

ready_to_process_at

date-time

Timestamp indicating when the transaction is ready to be processed

failure_code

string

Code indicating the reason for transaction failure, if applicable

failure_reason

string

Description of the reason for transaction failure, if applicable

customer_vpa

string

Virtual Payment Address of the customer, if applicable

type

enum

➔ Type of the transaction

Allowed: nach_debit┃upi┃payment_link┃upi_debit

txn_ref

string

Reference number for the transaction

utr

string

Unique Transaction Reference number for the transaction

settlement_desc

string

Description of the settlement

- settlement_details

object

settlement_bank_account_name

string

Name of the settlement bank account

total_amount

number

Total amount to be settled

tax1

number

First tax amount deducted from the settlement

tax2

number

Second tax amount deducted from the settlement

tax3

number

Third tax amount deducted from the settlement

fee1

number

First fee amount deducted from the settlement

fee2

number

Second fee amount deducted from the settlement

final_amount

number

Final amount after taxes and fees have been deducted

status

enum

➔ Status of the external settlement

Allowed: scheduled┃settle_success

consolidation_id

string

Consolidation identifier for the settlement

settlement_bank_txn_ref

string

Bank transaction reference for the settlement

account_number

string

Account number associated with the settlement

digio_utr

string

Digio's unique transaction reference number

settlement_date

date-time

Date of settlement for the transaction

parent_transaction_id

string

Identifier of the parent transaction, if any

- settlement_transaction_details

array of object

List of details for each settlement transaction

txn_id

string

Transaction ID of the debit transaction

amount_in_paise

integer

Amount in paise of the debit transaction

account_number

string

Account number associated with the transaction

settlement_utr_number

string

Unique Reference Number for the settlement

settlement_date

date-time

Date and time when the settlement was processed

- mandate

object

Mandate information associated with the scheduled plan

string

Unique identifier for the UPI mandate

customer_id

string

Customer ID associated with the mandate

customer_name

string

Name of the customer

customer_identifier

string

Identifier for the customer, such as a phone number

customer_vpa

string

Virtual Payment Address of the customer

partner_bank_code

string

Bank code of the partner bank

customer_ref_number

string

Reference number of the customer, not present in the provided JSON but assumed to be relevant

scheme_ref_number

string

Reference number of the scheme, not present in the provided JSON but assumed to be relevant

is_recurring

boolean

➔ Indicates if the mandate is for recurring payments

Default: false

frequency

enum

➔ Frequency of the mandate collection

Allowed: ADHO┃INDA┃DAIL┃WEEK┃MNTH┃QURT┃MIAN┃YEAR┃ONETIME┃BIMN

first_collection_date

date-time

Date for the first collection attempt

final_collection_date

date-time

Date for the final collection attempt

collection_amount

number

Amount to be collected per transaction

maximum_amount

number

Maximum amount that can be collected

mandate_type

enum

➔ Type of the mandate

Allowed: CREATE┃AMEND┃CANCEL

auth_type

enum

➔ Authentication type for the mandate

Allowed: UPI

status

enum

➔ Current status of the mandate

Allowed: PARTIAL┃AUTH_FAILED┃AUTH_SUCCESS┃REGISTER_FAILED┃REGISTER_SUCCESS┃PAUSED┃CANCELLED┃EXPIRED┃REVOKED

org_psp_ref_no

string

Reference number provided by the organization's PSP

umrn

string

Unique Mandate Reference Number

authentication_time

date-time

Timestamp when the mandate was authenticated

debit_ifsc

string

IFSC code of the debit account

failure_message

string

Message describing the reason for any failure

debit_account

string

Debit account number

narration

string

Narration for the mandate

corporate_config_id

string

Configuration ID for the corporate

merchant_code

string

Merchant code

service_provider_name

string

Name of the service provider

updated_at

date-time

Timestamp of the last update to the mandate

- 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

- details

object

first_proposed_settlement_date

date-time

Date for the first proposed settlement

next_scheduled_settlement_date

date-time

Date for 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

narration

string

Narration or description of the payment schedule

amount_in_paise

integer

Amount to be paid in paise

txn_reference

string

Transaction reference

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

- transactions

array of object

List of all transactions for the specific UPI schedule plan
⮕ [ List of all transactions for the specific UPI schedule plan ]

string

Unique identifier for the transaction

umrn

string

UMRN associated with the transaction

state

enum

➔ State of the transaction

Allowed: scheduled┃skipped┃notified┃processing┃delayed┃failed┃authenticated┃success

created_at

date-time

Creation timestamp of the transaction

updated_at

date-time

Update timestamp of the transaction

status_updated_at

date-time

Timestamp when the transaction status was last updated

- customer

object

name

string

Name of the customer

identifier

string

Unique ID of the customer

- details

object

Detailed information about the UPI transaction

status

enum

➔ Status of the NACH payment transaction

amount

number

Transaction amount in standard currency units

amount_in_paise

integer

Transaction amount in the smallest currency units (e.g., paise)

sponsor_bank_id

string

Identifier for the sponsor bank

ready_to_process_at

date-time

Timestamp indicating when the transaction is ready to be processed

failure_code

string

Code indicating the reason for transaction failure, if applicable

failure_reason

string

Description of the reason for transaction failure, if applicable

customer_vpa

string

Virtual Payment Address of the customer, if applicable

type

enum

➔ Type of the transaction

Allowed: nach_debit┃upi┃payment_link┃upi_debit

txn_ref

string

Reference number for the transaction

utr

string

Unique Transaction Reference number for the transaction

settlement_desc

string

Description of the settlement

- settlement_details

object

settlement_bank_account_name

string

Name of the settlement bank account

total_amount

number

Total amount to be settled

tax1

number

First tax amount deducted from the settlement

tax2

number

Second tax amount deducted from the settlement

tax3

number

Third tax amount deducted from the settlement

fee1

number

First fee amount deducted from the settlement

fee2

number

Second fee amount deducted from the settlement

final_amount

number

Final amount after taxes and fees have been deducted

status

enum

➔ Status of the external settlement

Allowed: scheduled┃settle_success

consolidation_id

string

Consolidation identifier for the settlement

settlement_bank_txn_ref

string

Bank transaction reference for the settlement

account_number

string

Account number associated with the settlement

digio_utr

string

Digio's unique transaction reference number

settlement_date

date-time

Date of settlement for the transaction

parent_transaction_id

string

Identifier of the parent transaction, if any

- settlement_transaction_details

array of object

List of details for each settlement transaction

txn_id

string

Transaction ID of the debit transaction

amount_in_paise

integer

Amount in paise of the debit transaction

account_number

string

Account number associated with the transaction

settlement_utr_number

string

Unique Reference Number for the settlement

settlement_date

date-time

Date and time when the settlement was processed

- sub_user

object

Only present if a sub-user has created the schedule.

string

Unique ID for sub-user

identifier_value

string

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

identifier

enum

➔ This denotes what type of identifier was used

Allowed: email┃mobile┃unknown

email_id

string

Sub-user's email id, if registered

mobile

string

Subuser's mobile number

created_at

date-time

Timestamp when the scheduled plan was created

updated_at

date-time

Timestamp when the scheduled plan was last updated

Create presentation for a multiple UMRNs

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

This API is used to create schedule plan for a multiple UMRN. Max number of presentations which can be created is 500 per api call.

REQUEST

REQUEST BODY application/json

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 hh:mm:ss

Default: (i) first_collection_date as provided in registered mandate OR (ii) current date Note : Settlement Date should be more than 26 hours from current time

corporate_account_number

string

➔ Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required. All numeric

Constraints: 8 to 18 chars

settlement_config_profile_id

string

Config of settlement, if already predefined. Any one of corporate_account_number or settlement_config_profile_id or split_settlement_info is required.

amount_in_paise

integer

Either of amount or amount_in_paise is mandatory

amount

number

Either of amount or amount_in_paise is mandatory.

narration

string

➔ Default: Enterprise name

Constraints: 1 to 20 chars

unique_key

string

➔ To be used for Corporate’s reference. Default: _ ex: _1, 2 Allowed chars: a-zA-Z.0-9 Note : It should be unique for each created debit.

Constraints: 1 to 30 chars

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

sub_user_identifier

string

Set value to assign it to a sub-user

- split_settlement_info

array of object

settlement_account_number

string

Bank Account Number

split_amount_in_paise *

integer

Amount to be settled in paise

frequency *

enum

➔

Default: ONETIME

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

payment_count

integer

➔ Should be non-negative and >= 1. payment_count has to be one if frequency is ONETIME

Default: 1

- optional_attr

object

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

member_id *

string

Member ID for whom the PA/ Bank is uploading the file

client_id

string

UCC for the said Client.

pg_bank_ref_number

string

Unique reference number provided by the member for payment to be collected for a unique client.

order_id

string

➔ Pass the Order Number for this SIP order

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

txn_type

string

Type of transaction

- upi_mandate_extended_detail

object

string

umrn

string

ownerId

string

customerRefNumber

string

customerVpa

string

customerName

string

schemeRefNumber

string

partnerBank

enum

➔

Allowed: KOTAK┃YESB┃JUSPAY_KOTAK┃MGS_YESB

frequency

enum

➔

Allowed: ADHO┃INDA┃DAIL┃WEEK┃MNTH┃QURT┃MIAN┃YEAR┃ONETIME┃BIMN

corporateConfigId

string

status

enum

➔

Allowed: authenticated┃register_failed┃register_success┃paused┃revoke_initiated┃cancelled┃expired┃revoked

mandateStartDate

date-time

mandateEndDate

date-time

amount

number

amountType

enum

➔

Allowed: fixed┃maximum

digioEnachId

string

identifier

string

sponsorBankCode

enum

➔

Allowed: KOTAK┃YESB┃JUSPAY_KOTAK┃MGS_YESB

authenticationTime

date-time

narration

string

destinationBankIfsc

string

mandateRequestId

string

serviceProviderName

string

statusUpdatedAt

date-time

customerAccountNumber

string

customerAccountType

enum

➔

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

merchantCategoryCode

string

subUserId

string

RESPONSE

application/json

Field

Type

Description

empty

boolean