List of Wallets [v3]

This API returns a list of wallets that can be shown to the user to select on your checkout. The list only includes wallets that are enabled for you. The API also returns if the wallet has any offers or additional charges to be levied. It also provides information about the health status of the wallet to process transactions.

application/json

Request Body required

All of the fields in the request body are optional, if you don't send any field, you need to send an empty body object. Empty request body will provide only the list of wallets without any offers or additional charges

order_id string

The order for which you want to display the list of wallets, if you don't pass this field then no offer or additional charge information will be calculated

total_amount number

The amount for which you want to display the list of wallets and calculate the offer and additional charges, you only need to pass the amount if you don't pass the order_id

currency string

Default value: INR

The currency code in ISO-4217 format example USD, INR, GBP, you only need to pass the currency if you don't pass the order_id

Responses

• 200
• 4XX
• 5XX

---

When the list of wallets is successfully fetched, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

wallet_list object[]
Array [
wallet_name string
The name of the wallet, it can be used in subsequent API calls
code string
This is a unique wallet code created by Nimbbl, it can be used in subsequent API calls
logo string
This is a public URL from which the logo of the wallet 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
]
]

{
  "wallet_list": [
    {
      "wallet_name": "Airtel Money",
      "code": "airtel_money",
      "logo": "https://s3.ap-south-1.amazonaws.com/nimbbl/wallet/airtel_money_v1.png",
      "next": [
        {
          "action": "initiate_payment",
          "url": "/api/v3/initiate-payment"
        }
      ]
    }
  ]
}

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...