Checkout Details

This API returns the details of Checkout .

Responses

• 200
• 4XX
• 5XX

---

When the api is successfull, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

sub_merchant_id string

This is the internal identifier for the sub merchant.

display_name string

The name of the bank, it can be used in subsequent API calls

logo_file_url string

This is a unique bank code created by Nimbbl, it can be used in subsequent API calls

description string

This is a public URL from which the logo of the bank can be fetched

ica_allowed boolean

This is a boolean field

mca_allowed boolean

This is a boolean field

checkout_background_color string

This is a color field

checkout_text_color string

This is a color field

fast_payment_enabled boolean

This is a boolean field

other_payment_enabled boolean

This is a boolean field

continue_btn_is_white boolean

This is boolean field

order_summary_enabled boolean

This is a boolean field

payment_experience string

This is a field

checkout_session_duration string

This is a field

country_code 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 [
isd_code string
This field denotes the country isd_code
country string
This field denotes the country
]
footer object
This field provides the health status of the bank, you can use this value to show to the user on the checkout if the bank is facing any problems in processing transactions
footer_logo_url string
footer_color string
footer_text_color_white boolean
footer_sub_text string
pci_dss_enabled boolean

{
  "sub_merchant_id": "303151",
  "display_name": "Nimbbl",
  "logo_file_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/black_logo_nimbbl_416f7e2c-f8d7-4046-ac27-e215940e0b0f.png",
  "description": "Nimbbl (Razorpay)",
  "ica_allowed": false,
  "mca_allowed": false,
  "checkout_background_color": "#000000",
  "checkout_text_color": "white",
  "fast_payment_enabled": true,
  "other_payment_enabled": true,
  "continue_btn_is_white": true,
  "order_summary_enabled": true,
  "payment_experience": "popup",
  "checkout_session_duration": 19,
  "country_code": [
    {
      "isd_code": "+1",
      "country": "USA"
    }
  ],
  "footer": {
    "footer_logo_url": "null",
    "footer_color": "#F2D8D8",
    "footer_text_color_white": false,
    "footer_sub_text": "Nimbbl Testing",
    "pci_dss_enabled": true
  }
}

When the list of wallets 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...