Create initial 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
pass the value shop
x-id
mandatory
merchant name
x-google-analytics-client-id
optional
client identifier for Google Analytics
Request parameters
Attribute
Type
Requirement
Description
Standard
isMobile
bool
mandatory
Indicates whether the checkout flow is initiated from a mobile device
-
currency
string
optional
Currency code used for the payment
ISO 4217 Alphabetic
discount
float
optional
Application of the discount (% value) to the initial cost of the product
min: 0.01,
max: 99.99
max: 99.99
sequence
string
optional
Internal user ID
-
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)
-
buyerMeta
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)
-
returnUrl
string
mandatory
The full URL of the merchant page to which the user will be redirected after a successful payment.
NOTE: The merchant may include custom query parameters in the URL using placeholders for values provided in
NOTE: The merchant may include custom query parameters in the URL using placeholders for values provided in
metaData or buyerMeta. These placeholders will be automatically replaced with the corresponding values from the request.-
products
array of objects
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
-
Response parameters
Attribute
Type
Description
data
object
Contains information related to the created order
meta
object
Provides metadata about the response
{
"data": {
"url": "https://some.url/jw1fe2Mz",
"params": {
"metaData": {
"foo": "bar"
},
"sequence": "123456123456123456",
"discount": 15,
"coupon": "123456",
"googleAnalyticsClientId": "GA1.3.1034945594.1649316099"
}
},
"meta": {
"type": "entity"
}
}{
"uuid": "3070b9cd-dd52-43eb-bd69-45f27b2d3e92",
"code": "3000",
"message": "Malformed request syntax.",
"traceId": "082d86c339533af07c14252afcecc7bd"
}{
"code": "0",
"message": "Malformed request syntax.",
"traceId": "082d86c339533af07c14252afcecc7bd",
"errors": [
{
"field": "coupon",
"title": "Coupon not found."
}
]
}{
"code": "0",
"message": "Short exception description.",
"traceId": "082d86c339533af07c14252afcecc7bd"
}Errors and interpretation
The list of possible errors for this endpoint, along with their types and interpretation, is provided in the general reference: Endpoint response errors.