Understand the Configuration

Payment Methods

Before deciding the payment methods or payment instruments that you want to configure on the Checkout, refer to the

Payment Instruments

A payment instrument is a combination of the payment method and its associated properties. For example, a payment instrument can be an AXIS Debit card, where card is the payment method and the issuer (AXIS bank) is the associated instrument.

An instrument is a JSON object with a key named method. Each method and its associated properties are described in the sections below:

Card

Payment instruments for the method: card are listed below:

// beginning of the code
....
card: { \\name for cards
    name: "Pay Via Cards"
    instruments: [
      {
        method: "card",
        issuers: ["UTIB"],
        networks: ["MasterCard"],
        types: ["debit","credit"]
      }
    ]
},
...
//rest of the code

Netbanking

Payment instruments for the method: netbanking are listed below:

Wallet

Payment instruments for the method: wallet are listed below:

UPI

Payment instruments for the method: upi are listed below:

Cardless EMI

Payment instruments for the method: cardless_emi are listed below:

Pay Later

For the method: paylater, the payment instruments are listed below:

Apps

For the method app, the payment instrument is listed below:

// beginning of the code
....
{
  "custom": {
    "name": "Pay with Apps",
    "instruments": [
      {
        "method": "app",
        "providers": [
          "cred"
        ]
      }
    ]
  }
}
...
//rest of the code

Blocks

A block is a collection of one or more payment instruments. Each block has a name and code associated as shown below:

// Block creation
let myPayments = {
  name: "My Custom Block",
  instruments: ["gpay", "freecharge"]
};
// Usage in config
let config = {
  display: {
    block: {
      highlighted: myPayments
    }
  }
};

Here, highlighted is the code associated with myPayments. Multiple blocks can be added to the config at the same time.

Sequence

You can specify the sequence, that is the order, in which the payment methods should be displayed on the Checkout.

A sequence is an array of strings, where each string is the name of the payment method or a block.

In a sequence, you can include any block using the block.${code} format. The block with code highlighted should be represented as block.highlighted as shown below:

let sequence = ["block.highlighted", "upi", "netbanking"];

The above sequence will place the code highlighted first followed by the payment methods upi and netbanking in that particular order.

Preferences

Using the preferences object, you can enhance the configuration of the Checkout. By setting this value, you can decide whether the default list of payment methods should be displayed or not.

Possible values are:

Hide Payment Instruments

You can also hide or remove certain instruments from the Checkout.

This is an array containing the method key used to hide either the payment method and/or the payment instrument associated with that payment method. For example, you can hide the methods, card and HDFC netbanking on the Checkout.

let cardInstrument = {
  method: "card"
};

let instrumentOfSomeBank = {
  method: "netbanking",
  banks: ["UTIB"]
};

let hiddenInstruments = [cardInstrument, instrumentOfSomeBank];

Next Steps

Related Information

• Supported Methods

• Sample Codes