POST
/api/v2/initialize/v1
Create order

Creates an order and returns checkout URL and parameters.

Header parameters

AttributeTypeRequirementDescription
x-public-key string MANDATORY Public key that identifies the merchant account.
x-buyer-ip string MANDATORY Buyer IP address (IPv4/IPv6).
x-date string MANDATORY Request datetime in format Y-m-dTH:i:s.
x-token string MANDATORY Signature generated on merchant side (HMAC-SHA256).
x-source string MANDATORY Traffic source.
x-id string MANDATORY Request identifier.
x-google-analytics-client-id string MANDATORY Google Analytics Client ID.

Request parameters

Attribute Type Requirement Description
product object MANDATORY
name string MANDATORY Product name.
amount integer MANDATORY Amount in minor units.
currency string MANDATORY ISO 4217.
buyer object OPTIONAL
email string OPTIONAL Buyer email.
sequence string OPTIONAL Internal user ID.
autoChargeStatus boolean OPTIONAL Auto-charge flag (true/false) or null.
discount number OPTIONAL Discount amount.
coupon string OPTIONAL Coupon code or null.
metaData object OPTIONAL Additional metadata.
subbrand string OPTIONAL Subbrand alias.

Response parameters

Attribute Type Requirement Description
data object OPTIONAL
url string OPTIONAL Checkout redirect URL.
params object OPTIONAL
id string OPTIONAL
googleAnalyticsClientId string OPTIONAL
metaData object OPTIONAL
meta array OPTIONAL Metadata array (can be empty).

Errors and interpretation

See general reference: Endpoint response errors