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

Credit / Debit Card transaction

The API supports two card usage modes:

New Card

Use this mode when the card is provided for the first time.

Required parameters:
- card_number
- card_exp_year
- card_exp_month
- card_security_code
- name_on_card
- save_to_locker – set to true to store the card for future use
- tokenize – set to true to generate a reusable card token
Saved Card

Use this mode when a previously saved card is used.

Required parameters:
- card_token – received from the list-cards API
- card_security_code
Do not send card number or expiry-related fields when using a saved card.

Request

Response

API Endpoints

Sandbox Link

POST

https://api.sandbox.juspay.io/txns

Production Link

POST

https://api.juspay.io/txns

Body

                      order_id
                      *
                      

string

Mandatory

order_id pertaining to the order for which the payment is started.

                      merchant_id
                      *
                      

string

Mandatory

Unique identifier of the merchant assigned by us.

                      payment_method_type
                      *
                      

string

Mandatory

Must be CARD.

                      payment_method
                      
                      

string

One of VISA/MASTERCARD/MAESTRO/AMEX/RUPAY/ELO. This is usually inferred from the card number itself and we will take care of this if you are unable to provide this from your end.

                      card_token
                      
                      

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.

                      card_number
                      
                      

string

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, SODEXO saved cards, and saved cards of select issuing banks of MASTERCARD

                      save_to_locker
                      *
                      

boolean

Mandatory

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

If 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

Default is false. Set it to true if the user wishes to perform an EMI transaction on the given card.

                      emi_bank
                      
                      

string

Represents the bank that issued the card. Value must be one of the entries mentioned under EMI Bank in the support matrix below.

                      emi_tenure
                      
                      

integer

The tenure of the EMI in number of months.

                      auth_type
                      
                      

string

THREE_DS/OTP/VISA_CHECKOUT/MOTO (Non 3DS transactions)

                      emi_type
                      
                      

string

The type of EMI ie STANDARD_EMI or NO_COST_EMI

                      offers
                      
                      

array of Strings

The key offers should be passed only when juspay offers are being used. The value for this key can set as the offerID which is received from /v1/offers/list api

                      tokenize
                      *
                      

boolean

Mandatory

This is a boolean variable and accepts true/false. Required to be passed as true when card needs to be saved for future transactions.
(Note: This is an additional requirement along with save_to_locker)

                      identity_credentials
                      
                      

Object

(Note: Not mandatory for non-Brazilian transactions)

cpf

String

Conditional

Brazilian identity number without punctuation

                      cnpj
                      
                      

String

Conditional

Brazilian identity number for companies without punctuation

                      pix_key
                      
                      

String

Conditional

Nickname that identifies a user's transactional account in Brazil

Response Body

                      order_id
                      *
                      

string

Required

order_id

                      txn_id
                      *
                      

string

Required

txn_id

                      status
                      *
                      

string

Required

Example : PENDING_VBV

                      payment
                      *
                      

object

Required

                      authentication.method
                      *
                      

string

Required

                      authentication.url
                      *
                      

String

Required

                      txn_uuid
                      
                      

String

                      offer_details
                      
                      

String

                      offers
                      
                      

Array

Response Body

                      status
                      
                      

string

error

                      error_message
                      
                      

string

Order timed out

                      error_code
                      
                      

string

invalid_request

Have questions?
Need help? Contact support
LLM? Read llms.txt

Credit / Debit Card transaction

New Card

Saved Card