post https://api-staging.pluralonline.com/api/v1/order/create
This API Help to create an Order Token.
Request Body
Attribute | Data type | M/O/C | Description | |||
---|---|---|---|---|---|---|
merchant_data | {} | M | ||||
merchant_id | integer | M | merchant_id is the unique identifier of the merchant. | |||
merchant_access_code | string(Length = 50 Characters) | M | Plural provides Merchant access code to Merchant. merchant_access_code can be found under the credentials section of the settings section of Plural Console dashboard. | |||
merchant_return_url | string(Length=500 Characters) | M | Merchant url is provided by the Merchant. The customer is redirected to the merchant_return_url once the transaction is completed. | |||
merchant_order_id | string(Length = 200 Characters) | M | Unique Order id of transaction maintained at Merchant end | |||
payment_info_data | {} | M | ||||
amount | long | M | The amount of the order in paise. | |||
currency_code | string | M | Currency code in which in the payment is intended. The currency code for Indian rupee is 'INR'. | |||
order_desc | string | O | The decription of the order | |||
customer_data | {} | O | Customer's details is to be provided. | |||
country_code | string(Length = 10 Characters) | O | The country code of the mobile number of the customer. Country code for India is 91. | |||
mobile_number | string(Length = 20 Characters) | O | Mobile number of the customer. | |||
email_id | string(Length = 100 Characters) | O | Email id of the cusotmer. | |||
billing_address_data | {} | C | Billing address of the customer. | |||
first_name | string(Length=50 Characters) | First name of the customer. | ||||
last_name | string(Length=50 Characters) | Last name of the customer. | ||||
address1 | string(Length=200 Characters) | First line of the address of the customer. | ||||
address2 | string(Length=200 Characters) | Second line of the address of the customer. | ||||
address3 | string(Length=200 Characters) | Third line of the address of the customer. | ||||
pin_code | string(Length=50 Characters) | PIN Code | ||||
city | string(Length=50 Characters) | City | ||||
state | string(Length=50 Characters) | State | ||||
country | string(Length=50 Characters) | Country | ||||
shipping_address_data | {} | C | Shipping address details of the order. | |||
first_name | string(Length=50 Characters) | First name of the customer. | ||||
last_name | string(Length=50 Characters) | Last name of the customer. | ||||
address1 | string(Length=200 Characters) | First line of the address of the customer. | ||||
address2 | string(Length=200 Characters) | Second line of the address of the customer. | ||||
address3 | string(Length=200 Characters) | Third line of the address of the customer. | ||||
pin_code | string(Length=50 Characters) | PIN code | ||||
city | string(Length=50 Characters) | City | ||||
state | string(Length=50 Characters) | State | ||||
country | string(Length=50 Characters) | Country | ||||
product_info_data | {} | |||||
product_details | Array of object[{},{}] | C | The data of the products comprised in the order. This is required in case of Brand EMI. | |||
product_code | string | M | Product code of the products added in the order. This code is to be provided in case of offers applied on these products. | |||
product_amount | long | M | The product amount in paise. | |||
additional_info_data | {} | |||||
rfu1 | string(Length=200 Characters) | |||||
rfu2 | string(Length=200 Characters) | |||||
rfu3 | string(Length=200 Characters) | |||||
rfu4 | string(Length=200 Characters) | |||||
rfu5 | string(Length=200 Characters) | |||||
rfu6 | string(Length=200 Characters) | |||||
rfu7 | string(Length=200 Characters) | |||||
rfu8 | string(Length=200 Characters) | |||||
rfu9 | string(Length=200 Characters) | |||||
rfu10 | string(Length=200 Characters) | |||||
subscription_data | {} | |||||
plan_details | {} | |||||
merchantId | ||||||
startDate | string(UTC time format example: 2023-01-31T18:30:00Z ) | |||||
endDate | string(UTC time format example: 2023-02-15T18:30:00Z) | |||||
plan | {} | |||||
planId | string | required only for plural maintained plan | ||||
merchantPlanId | string | required only for merchant maintained plan | ||||
planName | required only for merchant maintained plan | |||||
frequencyType | required only for merchant maintained plan | |||||
amount | {} | required only for merchant maintained plan | ||||
value | string | |||||
currency | string | |||||
maxLimitAmount | {} | required only for merchant maintained plan | ||||
payment_category_type | string | value | string | |||
currency | string | |||||
Response Body
Fields | Data type | Description |
---|---|---|
token | string | Order token which requires in process payment API. Order token will be expire after threshold time |
plural_order_id | string | Plural order id |
Fields | Data type | Description |
---|---|---|
error_code | string | Response's error code |
error_message | string | Response error message |