Create order
This endpoint is designed to create orders on the Billing side to further process a payment to purchase a product or service.
Header parameters
Attribute
Requirement
Description
x-public-key
mandatory
a public key that identifies the merchant account (there can be several for one merchant)
x-buyer-ip
mandatory
is responsible for information about the buyer's IP address
x-date
mandatory
is responsible for the date and time of sending the request
x-token
mandatory
generated on the merchant side
x-source
mandatory
identifier of the type of service that is the initiator of the request
x-id
mandatory
service identifier from which the current request is made
x-google-analytics-client-id
mandatory
client identifier for Google Analytics
Request parameters
Attribute
Type
Requirement
Description
Standard
product
object
mandatory
Product information for purchase
-
buyer
object
optional
Information about the buyer trying to make the payment.
When generating orders from the Shop, the transfer of this key is MANDATORY
When generating orders from the Shop, the transfer of this key is MANDATORY
-
metaData
object
optional
Object of type “key-value”, to transmit the internal meta-information of the merchant
(this data is not used by the backend and is transmitted when sending various events on the order)
(this data is not used by the backend and is transmitted when sending various events on the order)
-
autoChargeStatus
bool | null
optional
Specifies autocharge settings for the product.
If null is transmitted, the autocharge will be displayed according to the precheck_autocharge_config setting.
If null is transmitted, the autocharge will be displayed according to the precheck_autocharge_config setting.
-
sequence
string
optional
Internal user ID
-
discount
integer
optional
Application of the discount to the initial cost of the product
-
coupon
string
optional
Application of the coupon discount to the initial cost of the product.
If a discount was applied to the initial price of the product, then the coupon is applied to the price including the discount.
If a discount was applied to the initial price of the product, then the coupon is applied to the price including the discount.
-
subbrand
string
optional
Sub-brand name.
It is necessary to transmit alias to the sub-brand. That is, a subbrand without a dot using “_”.
For example: Sub-brand moniterro.com should be transmitted as "moniterro_com" or sub-brand eyezy-app.org as "eyezy_app_org".
It is necessary to transmit alias to the sub-brand. That is, a subbrand without a dot using “_”.
For example: Sub-brand moniterro.com should be transmitted as "moniterro_com" or sub-brand eyezy-app.org as "eyezy_app_org".
-
The procedure for applying the discount and coupon to the price is as follows:
- First, a discount is applied to the price of the product.
- A coupon is then applied to the discounted product price.
- If no discount has been applied to the price, then the coupon is applied to the original price.
- If a discount has been transmitted but without a coupon, the discounted product price will be received.
- If no discount and coupon data have been transmitted, only the product price will be received.
Response parameters
Attribute
Type
Description
data
object
Contains information related to the created order
meta
array
Provides metadata about the response
{
"data": {
"url": "https://st-pay-front-eyezy-app-com.dmr308.co/initial-billing/jw1fe2Mz",
"params": {
"metaData": {
"foo": "bar"
},
"sequence": "123456123456123456",
"discount": 15,
"coupon": "123456",
"googleAnalyticsClientId": "GA1.3.1034945594.1649316099"
}
},
"meta": []
}