Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Get Mandate Details

get {BASE_URL}/v3/client/mandate/upi/{mandate_id}

This API is used to get the current status and details for a mandate by its id

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
PATH PARAMETERS
RESPONSE
application/json
object
Single line description
Field
Type
Description
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
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