Body
Credit / Debit Card transaction for EMI
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/txns
Production Link
POST
https://api.juspay.in/txns
Headers
Content-Type
*
String
Mandatory
application/x-www-form-urlencoded
For Card EMI:
order_id
*
string
Mandatory
order_id pertaining to the order for which the payment is started.
merchant_id
*
string
Mandatory
ID of the merchant_account that you hold with us.
payment_method_type
*
string
Mandatory
Must be CARD
payment_method
string
Values can be of one of VISA/MASTERCARD/MAESTRO/AMEX/RUPAY
card_token
*
string
Mandatory
A valid card token obtained using /card/list API. If you send this parameter, then card_number, name_on_card, card_exp_year, card_exp_month fields are not required. If the token is generated using the /card/tokenize API, card_number, name_on_card, card_exp_year, card_exp_month and card_security_code fields are not required.
NOTE: expiry of card_token is 15 mins from the time generation.
card_number
*
string
Mandatory
A valid credit/debit card number
name_on_card
string
Card holder name. Should contain alphabetical characters only.
card_exp_year
*
string
Mandatory
Represent the expiry year of the card as YY (two digits only)
card_exp_month
*
string
Mandatory
Represent the expiry month of the card as MM (two digits only)
card_security_code
*
string
Mandatory
CVV of the card. Usually three digits. Optional for all VISA saved cards, PLUXEE | SODEXO saved cards, and saved cards of select issuing banks of MASTERCARD
save_to_locker
boolean
Optional
This is a boolean variable and accepts true/false. If set to true, then the card will be saved in locker when the transaction is successful. Else, the card will not be saved.
redirect_after_payment
*
boolean
Mandatory
This is a boolean variable and accepts true/false. We recommend that you set this to true and use the redirection flow. If set to true, then the user is redirected to the return_url configured for the order. If set to false, then the user will be stopped at the response page from the gateway. Your client should be able to read the page/title to infer that the user has completed the transaction.
format
*
string
Mandatory
it is set to json, then the response will be HTTP 200 with a JSON formatted text. Otherwise, the response is HTTP 302 with the Location attribute having the destination URL.
is_emi
*
boolean
Mandatory
Default is false. Set it to true if the user wishes to perform an EMI transaction on the given card.
emi_bank
*
string
Mandatory
Represents the bank that issued the card. Value must be one of the entries mentioned under EMI Bank in the support matrix below.
Bank code can be referred here
.
emi_tenure
*
integer
Mandatory
The tenure of the EMI in number of months.
auth_type
string
THREE_DS/OTP/VISA_CHECKOUT
emi_type
*
string
Mandatory
The type of EMI ie STANDARD_EMI
supported_gateway_id
Array of Integers
Array of gateway IDs should be passed, only for EMI transactions. If an EMI plan is supported by a specific set of gateways, then the same list should be passed in this field so that transaction will get routed to the proper gateway. Read ‘gateway_id‘ from ‘supported_gateways‘ in EMI Plans v2 response
For Cardless EMI:
order_id
*
string
Mandatory
order_id pertaining to the order for which the payment is started.
merchant_id
*
string
Mandatory
ID of the merchant_account that you hold with us.
payment_method_type
*
string
Mandatory
Must be CONSUMER_FINANCE.
payment_method
string
Value must be CONSUMER_FINANCE
redirect_after_payment
*
boolean
Mandatory
This is a boolean variable and accepts true/false. We recommend that you set this to true and use the redirection flow. If set to true, then the user is redirected to the return_url configured for the order. If set to false, then the user will be stopped at the response page from the gateway. Your client should be able to read the page/title to infer that the user has completed the transaction.
format
*
string
Mandatory
it is set to json, then the response will be HTTP 200 with a JSON formatted text. Otherwise, the response is HTTP 302 with the Location attribute having the destination URL.
is_emi
*
boolean
Mandatory
Default is false. Set it to true if the user wishes to perform an EMI transaction on the given card.
emi_bank
*
string
Mandatory
Represents the bank that issued the cardless EMI. Value must be one of the entries mentioned under EMI Bank in the support matrix below.
Bank code can be referred here.
emi_tenure
*
integer
Mandatory
The tenure of the EMI in number of months.
emi_type
*
string
Mandatory
The type of EMI ie STANDARD_EMI
supported_gateway_id
*
Array of Integers
Mandatory
Array of gateway IDs should be passed, only for EMI transactions. If an EMI plan is supported by a specific set of gateways, then the same list should be passed in this field so that transaction will get routed to the proper gateway. Read ‘gateway_id‘ from ‘supported_gateways‘ in EMI Plans v2 response
200 : Success
Response Body
order_id
string
:order_id
txn_id
string
:txn_id
status
string
PENDING_VBV
payment
object
authentication.method
string
authentication.url
String
400 : Invalid Input data
Response Body
status
string
error
error_message
string
Order timed out
error_code
string
invalid_request