Fetch details of the debit request created
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/upi_payment/scheduled/{planId}
This API is used to get debit request for created presentations
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 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
id
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
id
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
-
mandate
object
Mandate information associated with the scheduled plan
id
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 ]
id
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
-
sub_user
object
Only present if a sub-user has created the schedule.
id
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
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