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/nach_debit/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
transaction_id *
string

Transaction id i.e. NPT id which refers to the specific transaction against a schedule.
action *
enum

➔ Action to be performed on the transaction. Use case:
cancel (allowed only before initiation)
reattempt (allowed only after failure) - Incase of failure of an earlier mandate
Allowed: cancel┃reattempt┃update┃approve
RESPONSE
application/json
object
Single line description

Details of the last transaction
Field
Type
Description
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
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