Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Transaction Action

post {BASE_URL}/v3/client/upi_payment/transaction/action

This API is used to cancel/reattempt a single transaction

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

➔ Transaction id to be actioned upon. This is the NPT id which is created against a scheduled payment.
Constraints: 30 to 30 chars
action *
enum

➔ Pass one from below:
cancel (allowed only before initiation)
reattempt (allowed only after failure) - In-case of failure of an earlier debit and this is only possible if the failure status arrives the same day (up to 5 times)
Allowed: cancel┃reattempt┃update┃approve
extReferenceIdentifier
string
RESPONSE
application/json
object
Single line description

List of all transactions for the specific UPI schedule plan
Field
Type
Description
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
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