Skip to main content

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.

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

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


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

  • ]
  • ]
Loading...