Live demo of agent247 on Digio's docs — click the orange button at the bottom right to start.

Additional Physical Mandate APIs

Additional apis for physical mandate

Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Download NACH physical form [Physical NACH]

post {BASE_URL}/v3/client/mandate/{id}/generate_file

This API is used to download filled NACH PDF form. The id used here is ENA which is generated in create mandate api.

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
PATH PARAMETERS
RESPONSE

Returns the filled NACH PDF form as a binary stream.
application/octet-stream
Single line description
Field
Type
Description
binary

A binary stream of the filled NACH PDF form.
application/json 
 Schema not found
Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Submit Scanned Image [Physical NACH]

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

This API is used to Submit signed scanned image of NACH form

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
REQUEST BODY multipart/form-data
RESPONSE
application/json
object
Single line description
Field
Type
Description
success
boolean

Depicting whether the request failed or not
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
Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Submit Scanned Image RAW [Physical NACH]

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

This API is used to Submit signed scanned image of NACH form

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
QUERY-STRING PARAMETERS
REQUEST BODY application/json
object
Single line description
Field
Type
Description
id
string

Physical mandate id
file_data
string

Base64 Encoded image
RESPONSE
application/json
object
Single line description
Field
Type
Description
success
boolean

Depicting whether the request failed or not
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
Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Download Mandate Files (XML and processed images) [Physical NACH]

get {BASE_URL}/v3/client/mandate/download

This API is used to download files related to physical nach using mandate id

Requires Base 64 encoded clientId:clientSecret in Authorization header
REQUEST
QUERY-STRING PARAMETERS
RESPONSE

Successfully downloaded the document
*/*
Single line description
Field
Type
Description
file

Zip File
application/json 
 Schema not found
Digio Apis

Getting started with Digio Rest Apis

API SERVER

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

Share Mandate Files

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

This API is used to share mandate files directly with bank

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

Mandate ID registered at our end
partner_entity_email
string

Email of bank to whom the mandate is to be shared with
RESPONSE
application/json
object
Single line description
Field
Type
Description
success
boolean

Depicting whether the request failed or not
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

Was this page helpful?

Cancel Mandate RequestError Codes