Cancel Mandate RequestNEW

Create a cancellation request for an existing registered mandate.

Mandate can be cancelled using UMRN or Digio Mandate ID, if both UMRN and DIGIO Mandate ID are passed, 1st preference is given to UMRN. The reason being, in case of E-mandate(s), there can be instances of multiple UMRNs against the same DIGIO Mandate ID (owed to Customer retries because of Destination bank time-outs, screen closures, etc)

Cancel existing registered mandate

post {BASE_URL}/v3/client/mandate/registration_cancel

This API is used to create a cancellation request for an existing registered mandate

REQUEST

REQUEST BODY * application/json

Field

Type

Description

digio_mandate_id

string

ENA id of the mandate

umrn

string

UMRN of the mandate to be cancelled

reason

enum

➔ Cancellation Reason
C001: Cancellation on customer request
C002: Cancellation on corporate request
C003: Account closed or frozen or inoperative
C004: Cancelled from bank side

Allowed: C001┃C002┃C003┃C004

dest_ifsc

string

IFSC code of the destincation bank

RESPONSE

application/json

Field

Type

Description

string

Unique ID to identify mandates provided by Digio.

mandate_id

string

Unique ID to identify mandates provided by Digio.

state

enum

➔ 'partial': 'signed': 'expired': 'auth_success': 'auth_failed': 'cancelled': 'revoked':

Allowed: partial┃complete┃signed┃expired┃auth_success┃auth_failed┃cancelled┃revoked

type

enum

➔ Use case of mandate

Allowed: CREATE┃AMEND┃CANCEL

- bank_details

object

Details of bank

shared_with_bank

string

Email id of bank

bank_name

string

Name of the bank

state

enum

➔ Status with the bank

Allowed: created┃ready┃downloaded┃failed┃auth_success┃successful┃partial┃sign_pending┃signed┃transfer_failed┃transfer_success┃reject_spo_bank┃accepted_spo_bank┃awaiting_ack┃nack_received┃ack_received┃awaiting_res┃register_failed┃register_success┃revoked

shared_at

date-time

Time at which shared with the respective bank

authenticated_at

date-time

Time of authentication with the bank

- ack_report

array of object

List of acknowledgments received from bank's end
⮕ [ List of acknowledgments received from bank's end ]

string

Unique ID for acknowledgment

umrn

string

UMRN received from bank

message_id

string

Message ID received for acknowledgement

original_message_id

string

Original Message ID against which the acknowledged is received

enach_id

string

Mandate ID

accepted

boolean

This depicts whether the mandate was accepted or rejected

generated_at

date-time

Time at which acknowledgment was received

file_name

string

Acknowledgment file name

reject_code

string

If rejected, this denotes the code

reject_reason

string

Descriptive reason in case of rejection

created_at

date-time

Timestamp of acknowledgment

updated_at

date-time

Timestamp of last modification of the acknowledgment

- res_report

array of object

List of response received from bank's end
⮕ [ List of response received from bank's end ]

string

Unique ID for response

umrn

string

UMRN received from bank

message_id

string

Message ID received for response

original_message_id

string

Original Message ID against which the response is received

enach_id

string

Mandate ID

accepted

boolean

This depicts whether the mandate was accepted or rejected

generated_at

date-time

Time at which response was received

file_name

string

Response file name

reject_code

string

If rejected, this denotes the code

reject_reason

string

Descriptive reason in case of rejection

dest_bank_name

string

Name of destination bank

dest_bank_id

string

Id of destination bank

created_at

date-time

Timestamp of response

updated_at

date-time

Timestamp of last modification of the response

- 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┃any┃upi

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: ADHO┃INDA┃DAIL┃WEEK┃MNTH┃QURT┃MIAN┃YEAR┃ONETIME┃BIMN

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

- sub_user

object

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

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

- service_provider_details

object

Details of service provider

service_provider_name

string

Service provider name

service_provider_utility_code

string

Utility code of service provider

is_enabled_for_aadhaar_auth

boolean

It is only applicable for API mandate and it returns true/false. If the sponsor bank supports authentication using aadhaar then it returns true, else it returns false.

npci_auth_failed_error

string

Failure reason if shared by NPCI after rejecting a request at NPCI gateway level

npci_auth_reject_reason

string

Failure reason if shared by bank post NPCI gateway acceptence