List of Payment Modes [v3]

This API returns a list of payment modes that can be shown to the user to select on your checkout. The list only includes payment options that are enabled for you. The API also returns if the payment mode has any offers or additional charges to be levied.

application/json

Request Body required

order_id string required

This is the order_id returned by Nimbbl in response to the create order API

Responses

• 200
• 4XX
• 5XX

---

When the list of payment modes are fetched, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

fast_payment_mode object
These are payment modes that are enabled for you and personalised for the customer.
parent_display_tray string
Possible values: [fast]
The display tray provides a hierarchy of how you can display these payment modes on your checkout. In the fast_payment_mode object currently only a single tray is supported and all underlying payment methods can be shown in the same hierarchy and there is a single parent called fast
display_tray_name string
The name of the display tray under which the payment modes can be shown on your checkout.
display_tray_logo string
The logo of the display tray to be shown along side the display tray name on your checkout.
display_tray_subtext string
The description or sub text to be shown along with the display tray.
items array
This key will return an array of payment modes that belong to the customer, these are linked with the mobile number and email id of the customer that you have shared in the create-order API
payment_mode_code string
This is the code for the payment mode created by Nimbbl, it could be used in subsequent API calls
• pay_later
• upi
---
payment_mode string
Possible values: [Pay Later]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
pay_later_code string
Possible values: [lazypay, simpl, paytm_paylater, icici_paylater, mobikwik_zip, kreditbee_paylater, freecharge_paylater, kissht_paylater]
This is the code for the pay later created by Nimbbl, it could be used in subsequent API calls
pay_later_name string
The name of the pay later provider, it can be used in subsequent API calls
schemes object[]
The scheme contains details regarding the financing plans provided by the pay later provider
Array [
due_date date-time
This is the due date on which the first EMI will need to be paid. For single EMI period pay laters, this will be the date on which repayment will be due
total_emi number nullable
This is the total number of EMIs that will need to be repaid
scheme_id string nullable
This is the unique scheme id provided by Nimbbl, it will be required in subsequent API calls
processing_fee number nullable
This is the processing fee that will need to be paid by the customer to opt for this financing plan
irr number nullable
This is the annual percentage rate of the financing plan. This needs to be displayed to your customer as per RBI guidelines
emi number nullable
This is the instalment amount that the customer will need to repay when opting for this financing plan
interest number nullable
This is the interest portion of the instalment
downpayment number nullable
This is the down payment amount that the customer will need to pay first before the loan begins
balloon number nullable
This is for future use by Nimbbl
surcharge number nullable
This is for future use by Nimbbl
]
logo_url string nullable
This is a public URL from which the logo of the pay later provider can be fetched
tnc string nullable
This field provides the link to the terms and conditions of the paylater.
kfs string nullable
This field provides the link to the key fact statement of the paylater.
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
action string required
Possible values: [initiate_payment]
Once your customer has chosen their payment method and provided all information to initiate the payment, you can use this API
url string required
Possible values: [/api/v3/initiate-payment]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
payment_mode string
Possible values: [UPI]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
payment_flow string
This is the UPI payment flow that is available for you
• intent
• collect
---
upi_app_name string
This is the name of the UPI app
upi_app_code string
This is the code for the UPI app created by Nimbbl, it could be used in subsequent API calls
upi_app_name string
This is the name of the UPI app
upi_app_code string
This is the code for the UPI app created by Nimbbl, it could be used in subsequent API calls
upi_account_holder string
This is the name of the account holder who owns the UPI id
upi_id string
Possible values: Value must match regular expression [a-zA-Z0-9.\-_]{2,256}@[a-zA-Z]{2,64}
This is the UPI id of the customer
logo_url string nullable
This is a public URL from which the logo of the UPI app provider can be fetched
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
action string required
Possible values: [initiate_payment]
Once your customer has chosen their payment method and provided all information to initiate the payment, you can use this API
url string required
Possible values: [/api/v3/initiate-payment]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
amount_before_tax number
This is the amount before tax shared by you in the create-order API
tax number
This is the tax amount shared by you in the create-order API
currency string
This is the currency shared by you in the create-order API
total_amount number
This is the total amount shared by you in the create-order API
additional_charges number
This is the additional charge that will be charged for this payment mode
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount + additional_charges
offers object[] nullable
The offers array provides the list of offers configured by you along with the offer discount and grand total amount calculated as per the offer
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offer_discount number
This is amount that will be discounted as per the offers that have been configured by you
offer_id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
offer_name string
This is the offer name as configured
offer_start_date date-time
This is the offer start date in UTC
offer_end_date date-time
This is the offer end date in UTC
offer_description string
This is the description of the offer that can be used by you on your checkout
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount - offer_discount + additional_charges
]
other_payment_modes object
These are payment modes that are enabled for you but are not personalised for the customer.
parent_display_tray string
Possible values: [other]
The display tray provides a hierarchy of how you can display these payment modes on your checkout. In the other_payment_modes object, the parent tray will come as other. Payment modes below will be logically grouped in different display trays to help you build a checkout page
display_description string
The name of the display tray under which the payment modes can be shown on your checkout.
display_tray_logo string
The logo of the display tray to be shown along side the display tray name on your checkout.
display_tray_subtext string
The description or sub text to be shown along with the display tray.
items array
This key will return an array of payment modes that are enabled for you but aren't personalised for the customer
display_tray string
The display tray is a recommendation by Nimbbl to bunch certain payment modes together on your checkout
• card_tray
• upi_tray
• wallet_tray
• netbanking_tray
• standalone
---
payment_mode string
Possible values: [Credit Card, Debit Card, Prepaid Card]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
payment_mode_code string
Possible values: [credit_card, debit_card, prepaid_card]
This is the code for the payment mode created by Nimbbl, it could be used in subsequent API calls
amount_before_tax number
This is the amount before tax shared by you in the create-order API
tax number
This is the tax amount shared by you in the create-order API
currency string
This is the currency shared by you in the create-order API
total_amount number
This is the total amount shared by you in the create-order API
additional_charges number
This is the additional charge that will be charged for this payment mode
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount + additional_charges
offers object[] nullable
The offers array provides the list of offers configured by you along with the offer discount and grand total amount calculated as per the offer
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offer_discount number
This is amount that will be discounted as per the offers that have been configured by you
offer_id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
offer_name string
This is the offer name as configured
offer_start_date date-time
This is the offer start date in UTC
offer_end_date date-time
This is the offer end date in UTC
offer_description string
This is the description of the offer that can be used by you on your checkout
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount - offer_discount + additional_charges
]
logo_url string nullable
This is for future use by Nimbbl to fetch the logo of the payment mode from a public URL
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
anyOf
get-bin-data-action
initiate-payment-action
---
action string required
Possible values: [get_bin_data]
If you want to check details of the card entered by your customer on your checkout, then you can call this API
url string required
Possible values: [/api/v3/get-bin-data]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
action string required
Possible values: [initiate_payment]
Once your customer has chosen their payment method and provided all information to initiate the payment, you can use this API
url string required
Possible values: [/api/v3/initiate-payment]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
payment_mode string
Possible values: [UPI]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
payment_mode_code string
Possible values: [upi]
This is the code for the payment mode created by Nimbbl, it could be used in subsequent API calls
amount_before_tax number
This is the amount before tax shared by you in the create-order API
tax number
This is the tax amount shared by you in the create-order API
currency string
This is the currency shared by you in the create-order API
total_amount number
This is the total amount shared by you in the create-order API
additional_charges number
This is the additional charge that will be charged for this payment mode
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount + additional_charges
offers object[] nullable
The offers array provides the list of offers configured by you along with the offer discount and grand total amount calculated as per the offer
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offer_discount number
This is amount that will be discounted as per the offers that have been configured by you
offer_id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
offer_name string
This is the offer name as configured
offer_start_date date-time
This is the offer start date in UTC
offer_end_date date-time
This is the offer end date in UTC
offer_description string
This is the description of the offer that can be used by you on your checkout
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount - offer_discount + additional_charges
]
logo_url string nullable
This is for future use by Nimbbl to fetch the logo of the payment mode from a public URL
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
anyOf
validate-vpa-action
initiate-payment-action
---
action string required
Possible values: [validate_vpa]
If you want to validate the upi_id entered by the customer on your checkout, then you can call this API
url string required
Possible values: [/api/v3/validate-vpa]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
action string required
Possible values: [initiate_payment]
Once your customer has chosen their payment method and provided all information to initiate the payment, you can use this API
url string required
Possible values: [/api/v3/initiate-payment]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
payment_mode string
Possible values: [Wallet]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
payment_mode_code string
Possible values: [wallet]
This is the code for the payment mode created by Nimbbl, it could be used in subsequent API calls
amount_before_tax number
This is the amount before tax shared by you in the create-order API
tax number
This is the tax amount shared by you in the create-order API
currency string
This is the currency shared by you in the create-order API
total_amount number
This is the total amount shared by you in the create-order API
additional_charges number
This is the additional charge that will be charged for this payment mode
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount + additional_charges
offers object[] nullable
The offers array provides the list of offers configured by you along with the offer discount and grand total amount calculated as per the offer
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offer_discount number
This is amount that will be discounted as per the offers that have been configured by you
offer_id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
offer_name string
This is the offer name as configured
offer_start_date date-time
This is the offer start date in UTC
offer_end_date date-time
This is the offer end date in UTC
offer_description string
This is the description of the offer that can be used by you on your checkout
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount - offer_discount + additional_charges
]
logo_url string nullable
This is for future use by Nimbbl to fetch the logo of the payment mode from a public URL
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
action string required
Possible values: [list_of_wallets]
You can fetch the list of wallets and any corresponding offers available with them so you can show these to your customer on your checkout
url string required
Possible values: [/api/v3/list-of-wallets]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
payment_mode string
Possible values: [Netbanking]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
payment_mode_code string
Possible values: [net_banking]
This is the code for the payment mode created by Nimbbl, it could be used in subsequent API calls
amount_before_tax number
This is the amount before tax shared by you in the create-order API
tax number
This is the tax amount shared by you in the create-order API
currency string
This is the currency shared by you in the create-order API
total_amount number
This is the total amount shared by you in the create-order API
additional_charges number
This is the additional charge that will be charged for this payment mode
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount + additional_charges
offers object[] nullable
The offers array provides the list of offers configured by you along with the offer discount and grand total amount calculated as per the offer
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offer_discount number
This is amount that will be discounted as per the offers that have been configured by you
offer_id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
offer_name string
This is the offer name as configured
offer_start_date date-time
This is the offer start date in UTC
offer_end_date date-time
This is the offer end date in UTC
offer_description string
This is the description of the offer that can be used by you on your checkout
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount - offer_discount + additional_charges
]
logo_url string nullable
This is for future use by Nimbbl to fetch the logo of the payment mode from a public URL
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
action string required
Possible values: [list_of_banks]
You can fetch the list of banks and any corresponding offers available with them so you can show these to your customer on your checkout
url string required
Possible values: [/api/v3/list-of-banks]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
payment_mode_code string
This is the code for the payment mode created by Nimbbl, it could be used in subsequent API calls
• pay_later
• payment_app
---
payment_mode string
Possible values: [Pay Later]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
pay_later_code string
Possible values: [lazypay, simpl, paytm_paylater, icici_paylater, mobikwik_zip, kreditbee_paylater, freecharge_paylater, kissht_paylater]
This is the code for the pay later created by Nimbbl, it could be used in subsequent API calls
pay_later_name string
The name of the pay later provider, it can be used in subsequent API calls
schemes object[]
The scheme contains details regarding the financing plans provided by the pay later provider
Array [
due_date date-time
This is the due date on which the first EMI will need to be paid. For single EMI period pay laters, this will be the date on which repayment will be due
total_emi number nullable
This is the total number of EMIs that will need to be repaid
scheme_id string nullable
This is the unique scheme id provided by Nimbbl, it will be required in subsequent API calls
processing_fee number nullable
This is the processing fee that will need to be paid by the customer to opt for this financing plan
irr number nullable
This is the annual percentage rate of the financing plan. This needs to be displayed to your customer as per RBI guidelines
emi number nullable
This is the instalment amount that the customer will need to repay when opting for this financing plan
interest number nullable
This is the interest portion of the instalment
downpayment number nullable
This is the down payment amount that the customer will need to pay first before the loan begins
balloon number nullable
This is for future use by Nimbbl
surcharge number nullable
This is for future use by Nimbbl
]
logo_url string nullable
This is a public URL from which the logo of the pay later provider can be fetched
tnc string nullable
This field provides the link to the terms and conditions of the paylater.
kfs string nullable
This field provides the link to the key fact statement of the paylater.
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
action string required
Possible values: [initiate_payment]
Once your customer has chosen their payment method and provided all information to initiate the payment, you can use this API
url string required
Possible values: [/api/v3/initiate-payment]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
payment_mode string
Possible values: [Payment App]
This is the payment mode that needs to be shown to the customer, it can also be used in subsequent API calls
payment_app_code string
Possible values: [freecharge, paytm]
This is the code for the payment app created by Nimbbl, it could be used in subsequent API calls
payment_app_name string
Possible values: [Freecharge, Paytm]
The name of the payment app provider, it can be used in subsequent API calls
logo_url string nullable
This is for future use by Nimbbl to fetch the logo of the payment mode from a public URL
next object[]
The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided
Array [
action string required
Possible values: [initiate_payment]
Once your customer has chosen their payment method and provided all information to initiate the payment, you can use this API
url string required
Possible values: [/api/v3/initiate-payment]
This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc
]
amount_before_tax number
This is the amount before tax shared by you in the create-order API
tax number
This is the tax amount shared by you in the create-order API
currency string
This is the currency shared by you in the create-order API
total_amount number
This is the total amount shared by you in the create-order API
additional_charges number
This is the additional charge that will be charged for this payment mode
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount + additional_charges
offers object[] nullable
The offers array provides the list of offers configured by you along with the offer discount and grand total amount calculated as per the offer
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offer_discount number
This is amount that will be discounted as per the offers that have been configured by you
offer_id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
offer_name string
This is the offer name as configured
offer_start_date date-time
This is the offer start date in UTC
offer_end_date date-time
This is the offer end date in UTC
offer_description string
This is the description of the offer that can be used by you on your checkout
grand_total_amount number
This is the grand total that will be sent for processing i.e. the total_amount - offer_discount + additional_charges
]

{
  "fast_payment_mode": {
    "parent_display_tray": "fast",
    "display_tray_name": "string",
    "display_tray_logo": "string",
    "display_tray_subtext": "string",
    "items": [
      null
    ]
  },
  "other_payment_modes": {
    "parent_display_tray": "other",
    "display_description": "string",
    "display_tray_logo": "string",
    "display_tray_subtext": "string",
    "items": [
      {
        "payment_mode": "Credit Card",
        "payment_mode_code": "credit_card",
        "display_tray": "card_tray",
        "logo_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/card/visa_v1.png"
      },
      {
        "payment_mode": "Debit Card",
        "payment_mode_code": "debit_card",
        "display_tray": "card_tray",
        "logo_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/card/visa_v1.png"
      },
      {
        "payment_mode": "Prepaid Card",
        "payment_mode_code": "prepaid_card",
        "display_tray": "card_tray",
        "logo_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/card/visa_v1.png"
      },
      {
        "payment_mode": "UPI",
        "payment_mode_code": "upi",
        "display_tray": "card_tray",
        "logo_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/card/visa_v1.png"
      }
    ]
  }
}

When the list of payment modes cannot be fetched, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

error object

nimbbl_error_code string

This is the error_code generated by Nimbbl

nimbbl_consumer_message string

This is a customer friendly message that can be displayed to your consumer

nimbbl_merchant_message string

This explains to your team how to recover from the error

{
  "error": {
    "nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
    "nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
    "nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
  }
}

When there is a problem on the server, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

error object

nimbbl_error_code string

This is the error_code generated by Nimbbl

nimbbl_consumer_message string

This is a customer friendly message that can be displayed to your consumer

nimbbl_merchant_message string

This explains to your team how to recover from the error

{
  "error": {
    "nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
    "nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
    "nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
  }
}

Loading...