Fetch details of the debit request created using NSP ID or reference id.
Note: Pass 'unique key' used while creating debit request or the corporate_reference returned in create debit request api response
Digio Apis
Email:
support@digio.in
Getting started with Digio Rest Apis
API SERVER
SELECTED: https://api.digio.in
AUTHENTICATION
No API key applied
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
General ⦂
Get Debit Request Details
get
{BASE_URL}/v3/client/nach_debit/scheduled/{planId}
This API is used to get debit request for created presentations using the planid i.e. NSP which was created using the create debit request api.
Requires
Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
PATH PARAMETERS
|
*
planId
string
|
|
RESPONSE
application/json
object
Single line description
Field
Type
Description
id
string
Unique ID of created plan
umrn
string
Unique Mandate Reference Number
status
string
Current status of created plan
-
last_transaction
object
Details of the last transaction
id
string
ID of the last transaction
umrn
string
UMRN of the last transaction
state
string
State of the last transaction
created_at
date-time
Creation timestamp of the last transaction
updated_at
date-time
Last update timestamp of the last transaction
status_updated_at
date-time
Timestamp when the status was last updated
-
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
-
details
object
Detailed information about the last transaction
status
enum
➔ Status of the NACH payment transaction
Allowed: NEW┃READY_TO_SEND┃SKIPPED┃CANCELLED┃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
txn_ref
string
Reference number for the transaction
utr
string
Unique Transaction Reference number for the transaction
settlement_desc
string
Description of the settlement
-
mandate
object
Mandate information
id
string
Unique ID to identify mandates provided by Digio.
mandate_id
string
Unique ID to identify mandates provided by Digio.
state
enum
➔ This depicts the current state of mandate
Allowed: partial┃signed┃expired┃auth_success┃auth_failed┃cancelled┃revoked
type
enum
➔ The type for mandate which was requested
Allowed: CREATE┃AMEND
-
mandate_details
object
Details of mandate
file_name
string
Name of file shared with the bank
customer_identifier
string
Identifier for customer, could be email or mobile number
customer_name
string
Name of customer
customer_ref_number
string
Unique Reference Number identifier the customer
scheme_ref_number
string
Unique number maintained by Corporate for the reconciliation
customer_mobile
string
Mobile number of customer
customer_email
string
Customer email number
auth_type
enum
➔ Mode of authentication used for mandate
Allowed: API┃ESIGN┃PHYSICAL
authentication_time
date-time
Timestamp of mandate authentication
is_recurring
boolean
Denotes whether it is a recurring mandate or not
frequency
enum
➔ In case of recurring mandate, denotes the frequency.
Allowed: Adhoc┃IntraDay┃Daily┃Weekly┃Monthly┃BiMonthly┃Quarterly┃Semiannually┃Yearly
first_collection_date
date-time
Date of first debit
final_collection_date
date-time
Date of last debit
collection_amount
number
For fixed amount mandate, this denotes the amount
maximum_amount
number
Maximum amount that may be collected from the customer's account
customer_account_number
string
Masked account number of customer
customer_account_type
enum
➔ Type of bank account of customer
Allowed: SAVINGS┃CURRENT┃OTHER
destination_bank_id
string
IFSC code of customer's bank account
destination_bank_name
string
Name of customer's bank
sponsor_bank_name
string
Name of sponsor's bank account
npci_txn_id
string
Transaction ID in reference to NPCI
umrn
string
UMRN of the mandate registered
created_at
date-time
Timestamp at which mandate was created
updated_at
date-time
Last modification timestamp of the mandate
mode
enum
➔ Mode of mandate authentication
Allowed: API┃ESIGN┃PHYSICAL
auth_sub_mode
enum
➔ In case of API mandate, sub auth mode type
Allowed: net_banking┃debit┃aadhaar┃otp┃other┃pan┃customer_id┃direct_bank
-
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