Skip to main content

Create an Order [v3]‚Äč

This API creates an order and returns and order_id. To create an order, you will need to provide an amount, currency and and invoice_id. This invoice id will be your internal reference for the order. Order creation is the first step in processing payments. There are additional parameters also required for order creation and their significance is explained below.

Request Body required
    oneOf

    amount_before_tax double

    This is the amount before tax for your entire cart amount

    tax double

    This is the tax amount for your entire cart amount

    total_amount double required

    This is the total amount inclusive of taxes for your entire cart amount

    user object nullable

    User information is typically mandatory to create an order, in case you are unable to provide some user information, please reach out to our team and we can make certain fields nullable to meet your requirements

    email string required

    This is the email address of your consumer

    first_name string required

    This is the first name of your consumer

    last_name string

    This is the last name of your consumer

    country_code string required

    Default value: +91

    This is the country code as defined by the Internation Telecom Union

    mobile_number string required

    This is the mobile number of your consumer

    shipping_address object nullable

    Shipping information is typically mandatory to create an order, in case you are unable to provide shipping information, please reach out to our team and we can make certain fields nullable to meet your requirements

    address_1 string required

    This is the first line of the address for your consumer

    street string

    This is the name of the street of the address for your consumer

    landmark string

    This is the name of the landmark of the address for your consumer

    area string

    This is the name of the area of the address for your consumer

    city string required

    This is the name of the city of the address for your consumer

    state string required

    This is the name of the state of the address for your consumer

    pincode string required

    This is the pincode or zipcode of the address for your consumer

    address_type string required

    This is a name or tag given to a specific address

    currency string required

    Default value: INR

    This is the currency code in ISO-4217 format

    invoice_id uuid required

    This is your internal unique reference identifier for this order

    referrer_platform string nullable

    This is for internal use by Nimbbl

    referrer_platform_version string nullable

    This is for internal use by Nimbbl

    order_line_items object[] nullable

    This contains the cart items so that they can be displayed on the checkout or cart based offers can be calculated. Cart information is typically mandatory to create an order, in case you are unable to provide cart information, please reach out to our team and we can make certain fields nullable to meet your requirements

  • Array [
  • sku_id string

    This is the unique id of the product stored in your system

    title string

    This is the title of the product that is being sold

    description string

    This is the detailed description of the product being sold

    image_url string

    This is the public URL from which the image of the product can be fetched

    rate number

    This is the pre tax rate of the item

    quantity string

    This is the quantity that is being purchased

    amount_before_tax string

    This is the rate * quantity i.e. the amount before tax

    tax string

    This is the tax amount on the cart item

    total_amount string

    This is the sum of amount before tax and the tax amount

  • ]
  • bank_account object nullable

    This is required only if you need your payment processor to check if the payment made is from a specific bank account(Third Party Verification). This is typically a requirement while collecting payments for certain financial services.

    account_number string required

    This is the bank account number of the consumer

    name string required

    This is the name of the bank account holder

    ifsc string required

    Possible values: Value must match regular expression [A-Z]{4}0[A-Z0-9]{6}

    This is the Indian Financial System Code of the bank and its corresponding branch

    custom_attributes object nullable

    Custom attributes that are associated with the order in a key and value pair

    property name* string
Responses

When the order is successfully created, the response will be as below.


Schema
    order_id string

    This is the unique order_id generated by Nimbbl for the invoice_id shared by you. This will be used in subsequent API calls

    order_date date-time

    This is the date and time at which the order was created in UTC

    status string

    Possible values: [new]

    This is the status of the order, at the time of order creation, this will always be new

    invoice_id string

    This is your internal unique reference identifier for this order

    user object

    This is the user information fetched from Nimbbl depending on the user details shared during the create order API call

    email string nullable

    This is the email address of your consumer stored at Nimbbl

    first_name string nullable

    This is the first name of your consumer stored at Nimbbl

    last_name string nullable

    This is the last name of your consumer stored at Nimbbl

    country_code string

    Default value: +91

    This is the country code as defined by the Internation Telecom Union

    mobile_number string

    This is the mobile number of your consumer shared by you

    user_id string

    This is the unique identifier for the consumer on Nimbbl

    attempts integer

    This is the number of payment attempts made on this order, for a new order this will be 0

    currency string

    This is the currency code in ISO-4217 format

    amount_before_tax double

    This is the amount before tax for your entire cart amount

    tax double

    This is the tax amount for your entire cart amount

    total_amount double

    This is the total amount inclusive of taxes for your entire cart amount

    currency_conversion object nullable

    This object is sent only if the transaction currency was changed. This object will have all the details related to currency conversion.

    original_currency string

    This is the currency code in ISO-4217 format in which the order was initiated

    converted_currency string

    This is the currency code in ISO-4217 format in which the order will be processed in

    exchange_rate number

    This is the exchange rate used to convert amounts from original currency to converted currency

    conversion_reason string

    Possible values: [ALTERNATE_CURRENCY_CONFIG]

    This is the reason for currency conversion

    original_amount_before_tax number nullable

    This is the amount_before_tax received when the order was initiated

    original_tax number

    This is the tax when the order was initiated, if not received will be set to 0

    original_total_amount number

    This is the total_amount received when the order was initiated

    token string nullable

    This token should be used to launch checkout. This token has expiry of 20 minutes.

    token_expiration date-time nullable

    This is the expiry of the token, it is expressed in UTC. If the token has expired, you will need to use refresh token.

    refresh_token string

    This token is used to regenerate the token to launch the checkout. This token has expiry of 24 hours.

    refresh_token_expiration date-time

    This is the expiry of the token, it is expressed in UTC. If the token has expired, you will need to create a new order.

    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

    action string required

    Possible values: [payment_modes]

    To show on your checkout all the payment modes that are enabled for you and are personalised for your customer, you can call this API

    url string required

    Possible values: [/api/v3/payment-modes]

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