Skip to main content
POST
Create order

Authorizations

Authorization
string
header
required

Use your account's Secret Key as the Bearer token.

Body

application/json
name
string
required

Order description or product name.

Maximum string length: 120
Example:

"Product purchase"

value
number<float>
required

Order amount in the account's base currency.

Required range: x >= 0
Example:

150

buyer_id
integer

Customer ID of the buyer. Required unless auto_settle is 1 or trustee_type is account.

Example:

7485

seller_id
integer

Customer ID of the seller. Required unless auto_settle is 1.

Example:

7485

trustee_type
enum<string>

Pass account to use the authenticated account itself as the buyer (the buyer_id is then set automatically).

Available options:
account
fee_value
number<float>

Fixed platform fee amount. Cannot exceed value.

Required range: x >= 0
fee_percent
number<float>

Platform fee as a percentage. Min 0, max 100.

Required range: 0 <= x <= 100
tag
string

Custom reference tag.

Maximum string length: 100
auto_settle
enum<integer>

Set to 1 if there is no seller (e-commerce model). Auto-settles after payment.

Available options:
0,
1
metadata
object

Arbitrary key-value metadata stored on the order.

template
object

Custom template data for the checkout page.

images
string[]

Array of image URLs for the order.

Maximum array length: 10
buyer_confirmed_url
string<uri>

Redirect URL after buyer confirms payment.

buyer_denied_url
string<uri>

Redirect URL if buyer cancels payment.

seller_confirmed_url
string<uri>

Redirect URL after seller accepts the order.

seller_denied_url
string<uri>

Redirect URL if seller rejects the order.

payin_intents
integer

Maximum number of payin attempts allowed.

Required range: x >= 1
payin_method_types
string[]

Allowed payment method types for this order (e.g. ["CARD","BANKWIRE"]).

payin_method_fallback
string[]

Fallback payment methods if primary types fail.

buyer_billing_id
integer

Address ID to use as the buyer's billing address.

buyer_shipping_id
integer

Address ID to use as the buyer's shipping address.

subscription_id
integer

Associate this order with an existing ACTIVE subscription. The subscription must belong to the buyer_id customer.

discount_amount
number

Discount amount to apply to the order value.

Required range: x >= 0
discount_coupon_id
integer

Coupon ID to apply as a discount.

discount_wallet_id
integer

Wallet ID to fund a discount credit.

bundle
integer

Bundle ID to associate with this order.

Response

Order created

id
integer
self
string
Example:

"/2.0/orders/1234"

public_id
string | null
name
string
description
string | null
value
number

Order amount.

fee_value
number | null
fee_percent
number | null
currency
string
Example:

"EUR"

amount
string

Formatted amount with currency symbol.

Example:

"150.00 €"

payin_amount
string | null
payout_amount
string | null
fee_amount
string | null
shipping_amount
string | null

Payment URL to share with the buyer.

Acceptance URL to share with the seller.

QR code image URL for the order.

status
enum<string>
Available options:
DRAFT,
PENDING_DETAILS,
PENDING_PUBLISH,
PUBLISHED,
ACCEPTED,
REJECTED,
CANCELLED,
RELEASED
sandbox
boolean
status_nicename
string

Human-readable status label.

images
string[]
tag
string | null
payin_intents
integer | null
payin_types
string[] | null
payin_fallback
string[] | null
metadata
object | null
template
object | null
published_units
integer | null
refund
object
created_at
string<date-time> | null
published_at
string<date-time> | null

When the order was paid.

accepted_at
string<date-time> | null
shipping_at
string<date-time> | null
cancelled_at
string<date-time> | null
validated_at
string<date-time> | null
released_at
string<date-time> | null
connections
object

Hypermedia links to related resources.