Juspay Developer Guide

Welcome to the Juspay Developer Guide. You'll find comprehensive guides and documentation to help you start working with Juspay Docs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Dynamic Routing

Our approach

It is important to understand JusPay's implementation of dynamic routing to be able to configure gateway priorities correctly for your Merchant Account. Our approach has been to ensure maximum conversion rate and the implementation reflects this. The dynamic routing algorithm uses a non-deterministic mathematical model to rank all applicable gateways for the given transaction, using a lot of information, such as gateway health, gateway performance for a similar transaction recently, historical performance, etc.. Along with this, we take into account the priorities configured by you and arrive at the final gateway, such that the success probability is the highest.

So, please do not be surprised if a different gateway is chosen for a particular transaction which doesn't really align with your configuration. Getting you the maximum success rate is more important to us.

If a particular gateway is not applicable for a transaction, say payment mode is SBI NetBanking and gateway is HDFC PG, then that gateway will be automatically dropped by us. So, you don't have to take care of that in the priority logic.

Simple routing

Most typical routing logic would be to set up one gateway as primary and another gateway as secondary. Secondary gateway is usually used as a backup in case of primary gateway going down. However, there could be cases where a specific card BIN performs really well with the given PG and we might end up choosing the secondary gateway in such a case.

You can configure the priorities of gateways using a comma-separated string representation. For instance, say you have two gateways namely HDFC and ICICI. Now, if you need to setup HDFC as primary and ICICI as secondary, then you should configure the priorities as given below:

HDFC,ICICI

DSL

We understand that one size doesn't fit all. So, we have come up with another flexible option where you have the complete capability to dynamically set the priority.

You can describe the priority logic in Groovy code and set the priority dynamically for any given transaction. The gateways should be identified using the unique names (enumerations given below) and you are expected to setup the priority in the form of a string List. First gateway in the list has the highest priority and so will be preferred over others.

Note: Good code writing skills are necessary here. If you dont know what this is or is doubtful, please get in touch with us along with your requirement and we will help set this up for you.

Context

Transaction details are given as input to the DSL. Please see below for all the input variables that will be available to you in the DSL.

def order = [orderId: "orderId", amount: 5000.00, currency:"INR", preferredGateway: "AXIS", 
              udf1:"web", udf2: "desktop", udf3: "flight_booking", udf4: "", udf5: "", 
              udf6: "", udf7: "", udf8: "", udf9: "", udf10: ""]

def txn = [ txnId: "txnId", isEmi: true, emiBank: "HDFC", emiTenue: 6 ]

def payment = [cardBin: "524368", cardIssuer: "HDFC Bank", cardType: "CREDIT", cardBrand: "MASTERCARD", 
                paymentMethod: "MASTERCARD", paymentMethodType: "CARD", cardIssuerCountry: "INDIA"]

// use the below for randomization
long currentTimeMillis = _milliseconds_since_epoch_in_UTC;

// all the above variables are available to the DSL

Example 1. Routing based on Channel

def priorities = ['HDFC', 'ICICI', 'PAYU'] 
  // above is the default priority

  if (order.udf1 == 'web') {
    priorities = ['HDFC','PAYU','ICICI']
  }
  else if (order.udf1 == 'mobile' && order.udf2 == 'android')
    priorities = ['ICICI','HDFC','PAYU']
  }
  setGatewayPriority(priorities)

Example 2. Volume based routing

// def myGateways = ['HDFC','ICICI']
  // Goal: 50% approx split between two gateways

  if(currentTimeMillis % 10 < 5) {
    setGatewayPriority(['HDFC', 'ICICI'])
  }
  else {
    setGatewayPriority(['ICICI', 'HDFC'])  
  }

  // def myGateways = ["HDFC","ICICI", "AXIS"]
  // Goal: 1/2 split between two gateways and use third as backup
  if(currentTimeMillis % 10 < 5) {
    setGatewayPriority(['HDFC', 'ICICI', 'AXIS'])
  }
  else {
    setGatewayPriority(['ICICI', 'HDFC', 'AXIS'])
  }

Example 3. Issuer based routing

def priorities = [ 'HDFC', 'ICICI' ] 
  // default priorities
  if (payment.cardIssuer == 'ICICI Bank') { 
    // if ICICI Bank card, use ICICI
    priorities = [ 'ICICI', 'HDFC' ]
  }
  else if (order.udf1 == 'mobile' && order.udf2 == 'android')
    // for android transactions, use ICICI
    priorities = [ 'ICICI', 'HDFC' ]
  }
  else { // for everything else use HDFC as primary
    priorities = [ 'HDFC', 'ICICI' ]
  }
  setGatewayPriority(priorities)

Example 4. Card Brand based routing

def priorities = ['HDFC', 'ICICI', 'PAYU'] 
  // default priorities
  if (payment.cardBrand == 'MAESTRO') { 
    // if Maestro card, use ICICI as primary
    priorities = ['ICICI', 'PAYU', 'HDFC']
  }
  else if (payment.cardBrand == 'AMEX')
    priorities = ['PAYU', 'ICICI', 'HDFC']
  }
  setGatewayPriority(priorities)

Enumerations and Gateway IDs

GatewayGateway ID
AXIS1
HDFC2
ICICI3
CITI4
AMEX5
CYBERSOURCE6
IPG7
MIGS8
KOTAK9
EBS11
PAYU12
CCAVENUE_V216
TPSL17
PAYTM18
PAYTM_V219
PAYPAL20
HDFC_EBS_VAS21
PAYLATER22
RAZORPAY23
FSS_ATM_PIN24
EBS_V325
ZAAKPAY26
BILLDESK27
SODEXO28
BLAZEPAY29
FSS_ATM_PIN_V230
MOBIKWIK31
OLAMONEY32
FREECHARGE33
MPESA34
SBIBUDDY35
JIOMONEY36
AIRTELMONEY37
AMAZONPAY38
PHONEPE39
OLAPOSTPAID40
SIMPL41
GOOGLEPAY42
FREECHARGE_V243
STRIPE50
GOCASHFREE70
FSSPAY73
PINELABS74
DUMMY100
HDFC_IVR201
EPAYLATER251
LAZYPAY252
AXISNB300
HDFCNB301
ICICINB302
TPSL_SI400
AXIS_UPI500
HDFC_UPI501
INDUS_UPI502
KOTAK_UPI503
SBI_UPI504
ICICI_UPI505
VIJAYA_UPI506
HSBC_UPI507
YESBANK_UPI508
PAYTM_UPI509
LINEPAY600
CASH700
MORPHEUS800

List of card brands:

  • VISA
  • MASTERCARD
  • MAESTRO
  • RUPAY
  • AMEX
  • DINERS
  • DISCOVER

List of card types:

  • CREDIT
  • DEBIT

Configure priority

To set this up, please proceed to Gateways and enable the checkbox that says: I'd rather write code to define the priority. In the given text area, enter your DSL logic and then click on Update Gateway details.

Special rules

In addition to the routing logic explained above, we have also provided you with the ability to define specific rules to assign different gateway priorities for a given card BIN or card issuer bank. For instance, if you have negotiated special rates for HDFC cards on HDFC PG, then you can configure this on the dashboard.

ISIN & Issuer rules

ISIN stands for Issuer Identification Number which is card BIN (Bank Identification Number). For, a given ISIN and given Gateway, you can setup a priority score. If you wish to setup a rule for a particular card issuer bank, that can be configured too.

ISIN

Gateway

Score

524368

HDFC

1.1

447746

ICICI

1.1

Score

The score is expected to be in the range of 0.0 - 2.0 (decimals are allowed). Giving a value of 2.0 will increase the priority of the gateway by 2x. A value of 0.5 will reduce the priority score by 50%. A score of 1.0 will make the rule neutral.

Issuer Routing
The issuer typically refers to the bank which has issued the credit or debit card. In some countries, even credit unions or prepaid card providers can also issue cards. You can set up rules to specify dynamic scoring for a particular issuer and a gateway

Card Brand Routing
Card Brands include VISA, MASTERCARD, MAESTRO, AMEX, RUPAY, DISCOVER, DINERS, JCB. Setup your scoring to route based on a card brand and a gateway

Updated 11 months ago


Dynamic Routing


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.