JavaScript is disabled. Some features may not work. You can also read the static version: View text version

One Time Mandate

As per IRDAI notification Insurers are mandated to provide Bima-ASBA as a payment instrument, to ensure that “Premium is collected from the user only after the insurer communicates the acceptance of proposal.”

As a compliance measure to support Bima-ASBA, Insurers are requested to use, UPI One Time mandates which would block the amount in the User’s account and can be collected by the insurer before the issuance of the Policy.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/session

Production Link

POST

https://api.juspay.in/session

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Required

                      x-merchantid
                      
                      

String

Example:- yourMerchantId

                      Content-Type
                      
                      

String

Example:- application/json

Body

Request Schema: application/json

                      amount
                      
                      

String

Can be equal to the premium amount. It accepts stringified double or integer values with upto two decimal places. For example, "100.15" and "100" are valid input but "100.1532" is not valid.

Minimum value of amount should be INR 1.

Block will be on the mandate.max_amount.

                      order_id
                      *
                      

String

Required

Max Length : 21

It is a unique Identifier for the order. It should be Alphanumeric with character length less than 21.

                      customer_id
                      *
                      

String

Required

Max Length : 128

It is the unique identifier with which merchant refers to a customer object. It is used to access the saved payment methods, allow EMI transactions and setup subscriptions.

                      customer_phone
                      
                      

String

Max Length : 300

Mobile number or fixed line number of the customer. If the backend gateway requires it, then you must send this value. We recommend passing a 10-digit number without including the "+91" or any mobile country code at the beginning.

                      customer_email
                      
                      

String

Max Length : 300

Email address of the customer. If the backend gateway requires it, then you must send this value.

Constraints : You are allowed to use alphanumeric characters and the following special characters:!#$%&'*+-/=?^_.{|}~`@

_ and . cannot appear at the beginning or end of the local part of the email address (before and after the @ symbol).

                      payment_page_client_id
                      *
                      

String

Required

A unique identifier of merchant. This is available in welcome e-mail shared by Juspay

                      return_url
                      
                      

String

A fully qualified URL on which the customer will be redirected after payment completion. It is also required to provide the control back to SDK after the completion of transaction. This URL takes higher precedence over the common return URL configured in your account settings.

NOTE:

URL shouldn't contain any query parameters or Ip address.
URL should be a valid HTTPS endpoint that is reachable from Juspay servers.
Return URL should not redirect to a different URL.
Please ensure to pass a valid return URL in the session API call or configure it on the Juspay Dashboard. Not doing the same will lead the SDK not being closed post transaction completion.

                      action
                      
                      

String

Value "paymentPage" is to start the Hypercheckout interface.

                      options.create_mandate
                      
                      

String

For merchants who wants to set up mandates, can pass this as either “REQUIRED” or “OPTIONAL”. “REQUIRED” means that the transaction for this order has to be definitely converted to a mandate. “OPTIONAL” means that the final decision of conversion of the transaction lies with the user.

Example:- OPTIONAL/REQUIRED

                      mandate.frequency
                      
                      

String

Defines the frequency of mandate execution, how often a customer should be charged.
Data type ENUM:
ONETIME (Supported only by UPI)
By Default it is considered as ASPRESENTED

                      mandate.end_date
                      
                      

String

Mandatory for UPI Mandate. Mandate end date in UNIX EPOCH timestamp (UTC timezone). Post end date, mandate will move to EXPIRED state and recurring mandate will not be allowed. By default value will be Mandate start date + 30 years

                      mandate.max_amount
                      
                      

String

Maximum amount for a mandate. Required, only when amount type is variable. If amount type is fixed, amount is considered as max amount.

                      mandate.block_funds
                      
                      

String

Set to true if funds have to be blocked while a mandate is being created. Should be true for ONETIME and false for Recurring. By default value will be TRUE for ONETIME and FALSE for Recurring.

Response Body

                      status
                      
                      

String

Example:- NEW

id

String

Example:- ordeh_1662a30d94224d4a9a2cdc4c26ee9f37

                      order_id
                      
                      

String

Example:- yourUniqueOrderId

                      payment_links
                      
                      

Object

web

String

Example:- https://api.juspay.in/orders/ordeh_1662a30d94224d4a9a2cdc4c26ee9f37/payment-page

                      sdk_payload
                      
                      

Object

                      requestId
                      
                      

String

Example:- 76a19a48b9344be683430a99fde5fd8f

                      service
                      
                      

String

Example:- in.juspay.hyperpay

                      payload
                      
                      

Object

                      options.createMandate
                      
                      

String

Example:- REQUIRED

                      clientId
                      
                      

String

Example:- client_id

                      amount
                      
                      

String

Example:- 10.0

                      merchantId
                      
                      

String

Example:- merchant_id

                      environment
                      
                      

String

Example:- production

                      mandate.blockFunds
                      
                      

String

Example:- true

                      mandate.frequency
                      
                      

String

Example:- ONETIME

                      mandate.maxAmount
                      
                      

String

Example:- 1000.00

                      mandate.endDate
                      
                      

String

Example:- 1776073324

                      action
                      
                      

String

Example:- paymentPage

                      customerId
                      
                      

String

Example:- yourUniqueCustId

                      returnUrl
                      
                      

String

Example:- https://shop.merchant.com

                      currency
                      
                      

String

Example:- INR

                      customerPhone
                      
                      

String

Example:- customer_phone

                      customerEmail
                      
                      

String

Example:- customer_email

                      orderId
                      
                      

String

Example:- yourUniqueOrderId