Skip to main content
POST
Create payment

Authorizations

Authorization
string
header
required

Use your Shoppex API key in the Authorization header.

Body

title
string
required
Required string length: 1 - 128
email
string<email>
required
value
number
required

Unit price in currency. The total (value × quantity) is rounded half up to 2 decimals and must stay below 90,071,992,547,409.92 in a two-decimal currency; a larger total is refused with 422 VALIDATION_ERROR.

Required range: x >= 0.01
currency
string
required

ISO 4217 code. Currencies without a minor unit (JPY, HUF, ISK, KRW) are refused with 422 VALIDATION_ERROR, subcode errors.checkout.currency_not_supported.

Required string length: 3
quantity
number

A whole number up to 2147483647. Other quantities are refused with 422 VALIDATION_ERROR.

Required range: x >= 1
coupon_code
string

Shop-wide coupon applied to value × quantity. Product/variant-scoped coupons require POST /dev/v1/orders; refusals return 422 VALIDATION_ERROR with a coupon_* subcode.

gateway
string
crypto_gateway
string
cryptoGateway
string
gateways
string[]
confirmations
number
Required range: x >= 1
webhook
string
return_url
string
cancel_url
string
custom_fields
object[]
customFields
object[]
product_id
string
productId
string
items
object[]
cart
string
products
object[]
customer_id
string
fraud_shield
object

Response

Response for status 201

data
object
required