Create Order

post https://api-staging.pluralonline.com/api/v1/order/create

This API Help to create an Order Token.

Request Parameters:

AttributeTypeDetails
merchant_id*integermerchant_id is the unique identifier of the merchant.
merchant_access
_code*		string
(Length = 50 Characters)		Merchant unique identification id provided by Plural.
merchant_return
_url*		string
(Length=500 Characters)		Merchant url is the url to be provided by the merchant.
merchant_order_id*string
(Length = 200 Characters)		Unique Order id of transaction maintained at Merchant end
amount*longThe amount of the order in paise.
currency_code*stringCurrency code in which in the payment is intended. The currency code for Indian rupee is 'INR'.
order_descstringThe decription of the order.
country_code*string
(Length = 10 Characters)		The country code of the mobile number.
mobile_number*string
(Length = 20 Characters)		Mobile number of the customer.
email_id*string
(Length = 100 Characters)		Email id of the cusotmer.
billing_address
_data		{}
first_namestring
(Length=50 Characters)		biller address First name.
last_namestring
(Length=50 Characters)		biller address Last name.
address1string
(Length=200 Characters)		First line of the biller address .
address2string
(Length=100 Characters)		Second line of the biller address.
address3string
(Length=100 Characters)		Third line of the biller address.
pin_codestring
(Length=50 Characters)		PIN Code
citystring
(Length=50 Characters)		City
statestring
(Length=50 Characters)		State
countrystring
string
(Length=50 Characters)		Country
shipping_address
_data		{}
first_namestring
(Length=50 Characters)		shipping address First name.
last_namestring
(Length=50 Characters)		shipping address Last name.
address1string
(Length=200 Characters)		shipping address1.
address2string
(Length=100 Characters)		shipping address 2.
address3string
(Length=100 Characters)		shipping address 3.
pin_codestring
(Length=50 Characters)		Pincode
citystring
(Length=50 Characters)		city
statestring
(Length=50 Characters)		state
countrystring
(Length=50 Characters)		country
product_info
_data		product_details[]
(Array of Product Details which)		Need to send for Implementing Brand EMI
product_details()
product_code*stringProduct code of the products added in the order. This code is to be provided in case of offers applied on these products.
product_amount*longThe product amount in paise.
additional_
info_data		()
rfu1string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu2string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu4string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu5string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu6string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu7string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu8string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu9string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
rfu10string
(Length=200 Characters)		RFU value is allowed as alpha-numeric with “#”, "_" and “-”
subscription_data{}
plan_details{}
merchantIdstring
startDatestring(UTC time format
example: 2023-01-31T18:30:00Z )
endDatestring(UTC time format
example: 2023-02-15T18:30:00Z)
plan{}
planIdstringrequired only for plural maintained plan
merchantPlanIdstringrequired only for merchant maintained plan
planNamestringrequired only for merchant maintained plan
frequencyTyperequired only for merchant maintained plan
amount{}required only for merchant maintained plan
valuestring
currencystring
maxLimitAmount{}required only for merchant maintained plan
valuestring
currencystring
payment_category_typestring

Request Body payload: 

{
  "merchant_data": {
    "merchant_id": "11565",
    "merchant_access_code": "709ebcf1-3171-4b0a-891d-394fa259c63b",
    "merchant_return_url": "http://192.168.101.205:9073/chargingrespnew.aspx",
    "merchant_order_id": "MICROS"
  },
  "payment_info_data": {
    "amount": 500,
    "currency_code": "INR",
    "order_desc": "Test Order"
  },
  "customer_data": {
    "country_code": "91",
    "mobile_number": "xxx",
    "email_id": "[email protected]"
  },
  "billing_address_data": {
    "first_name": "Balwant",
    "last_name": "Singh",
    "address1": "Hisar",
    "address2": "Hisar",
    "address3": "Hisar",
    "pin_code": "125005",
    "city": "Hisar",
    "state": "Haryana",
    "country": "India"
  },
  "shipping_address_data": {
    "first_name": "Balwant",
    "last_name": "Singh",
    "address1": "Hisar",
    "address2": "Hisar",
    "address3": "Hisar",
    "pin_code": "125005",
    "city": "Hisar",
    "state": "Haryana",
    "country": "India"
  },
  "product_info_data": {
    "product_details": [
      {
        "product_code": "200",
        "product_amount": 500
      }
    ]
  },
  "additional_info_data": {
    "rfu1": "123"
  },
    "subscription_data": {
    "plan_details": {
			"merchantId": "3004",
  		"startDate": "2023-02-06T18:30:00Z",
		  "endDate": "2023-02-10T18:30:00Z",
  "plan": {
    "planId": "4",
    "merchantPlanId": "merch007",
    "planName": "MPPlanDayNT",
    "frequencyType": "Day",
    "amount": {
      "value": 220,
      "currency": "INR"
    },
    "maxLimitAmount": {
      "value": 220,
      "currency": "INR"
    }
  }
    }
  },
  "payment_category_type": "RECURRANCE"

}

Request Base64 Body payload: 

{
    "request": "ewogICJtZXJjaGFudF9kYXRhIjogewogICAgIm1lcmNoYW50X2lkIjogIjMwMDAwMDQiLAogICAgIm1lcmNoYW50X2FjY2Vzc19jb2RlIjogImUwZGE3Mzk1LTllNWEtNDhkMS1iMDExLTAxMjdlYzk1MWUiLAogICAgIm1lcmNoYW50X3JldHVybl91cmwiOiAiaHR0cDovLzEwLjIwOC44LjEzOTo5MDIwL2NoYXJnaW5ncmVzcG5ldy5hc3B4IiwKICAgICJtZXJjaGFudF9vcmRlcl9pZCI6ICJmZWIxMzAxIgogIH0sCiAgInBheW1lbnRfaW5mb19kYXRhIjogewogICAgImFtb3VudCI6IDEwMCwKICAgICJjdXJyZW5jeV9jb2RlIjogIklOUiIsCiAgICAib3JkZXJfZGVzYyI6ICJUZXN0IFN1YnNjcmlwdGlvbiBPcmRlciBjcmVhdGlvbiIKICB9LAogICJjdXN0b21lcl9kYXRhIjogewogICAgImNvdW50cnlfY29kZSI6ICI5MSIsCiAgICAibW9iaWxlX251bWJlciI6ICI5NDQ0NjAwNjkzIiwKICAgICJlbWFpbF9pZCI6ICJrLmRoYWtzaGluYW1vb3J0aHlAcGluZWxhYnMuY29tIgogIH0sCiAgImJpbGxpbmdfYWRkcmVzc19kYXRhIjogewogICAgImZpcnN0X25hbWUiOiAiRGhha3NoaW4iLAogICAgImxhc3RfbmFtZSI6ICJLcmlzaCIsCiAgICAiYWRkcmVzczEiOiAiQ2hlbm5haSIsCiAgICAiYWRkcmVzczIiOiAiQ2hlbm5haSIsCiAgICAiYWRkcmVzczMiOiAiQ2hlbm5haSIsCiAgICAicGluX2NvZGUiOiAiNjAwMDA0IiwKICAgICJjaXR5IjogIkNoZW5uYWkiLAogICAgInN0YXRlIjogIlRhbWlsTmFkdSIsCiAgICAiY291bnRyeSI6ICJJbmRpYSIKICB9LAogICJzaGlwcGluZ19hZGRyZXNzX2RhdGEiOiB7CiAgICAiZmlyc3RfbmFtZSI6ICJEaGFrc2hpbiIsCiAgICAibGFzdF9uYW1lIjogIktyaXNoIiwKICAgICJhZGRyZXNzMSI6ICJDaGVubmFpIiwKICAgICJhZGRyZXNzMiI6ICJDaGVubmFpIiwKICAgICJhZGRyZXNzMyI6ICJDaGVubmFpIiwKICAgICJwaW5fY29kZSI6ICI2MDAwMDQiLAogICAgImNpdHkiOiAiQ2hlbm5haSIsCiAgICAic3RhdGUiOiAiVGFtaWxOYWR1IiwKICAgICJjb3VudHJ5IjogIkluZGlhIgogIH0sCiAgInByb2R1Y3RfaW5mb19kYXRhIjogewogICAgInByb2R1Y3RfZGV0YWlscyI6IFsKICAgICAgewogICAgICAgICJwcm9kdWN0X2NvZGUiOiAidGVzdCIsCiAgICAgICAgInByb2R1Y3RfYW1vdW50IjogMTAwCiAgICAgIH0KICAgIF0KICB9LAogICJhZGRpdGlvbmFsX2luZm9fZGF0YSI6IHsKICAgICJyZnUxIjogIiIsCiAgICAicmZ1MiI6ICIiLAogICAgInJmdTMiOiAiIiwKICAgICJyZnU0IjogIiIsCiAgICAicmZ1NSI6ICIiCiAgfSwKICAidHB2X2RhdGEiOiB7CiAgICAiYWNjb3VudF9udW1iZXIiOiAiIgogIH0sCiAgInN1YnNjcmlwdGlvbl9kYXRhIjogewogICAgInBsYW5fZGV0YWlscyI6IHsKICAgICAgIm1lcmNoYW50SWQiOiAiMzAwNCIsCiAgICAgICJzdGFydERhdGUiOiAiMjAyMy0wMi0xM1QxODozMDowMFoiLAogICAgICAiZW5kRGF0ZSI6ICIyMDIzLTAyLTE1VDE4OjMwOjAwWiIsCiAgICAgICJwbGFuIjogewogICAgICAgICJwbGFuSWQiOiAiMTAwIgogICAgICB9CiAgICB9CiAgfSwKICAicGF5bWVudF9jYXRlZ29yeV90eXBlIjogIlJFQ1VSUkFOQ0UiCn0="
}

Response Payload: 

{
    "token": "VKbSh6LbRRCoJmw31hBQI6ISeb%2Bl43FUki9CjQGIQcs%3D",
    "plural_order_id": "33902"
}

{
    "error_code": "1160",
    "error_message": "SECURE_HASH_RETURNED_FROM_MERCHANT_NOT_MATCH"
}

{
    "error_code": "1130",
    "error_message": "DUPLICATE_ORDER_RECEIVED_ON_MERCHANT"
}

Response Parameters

Parameter NameTypeDescription
tokenstringcreate order token to pass for payment url.
plural_order_idstringunique order id.
Parameter NameTypeDescription
error_codestringResponse error code
error_messagestringResponse error message
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!