Order

Create a new order

Changed on
post/order

Request

Headers

X-API-Key-IDstring required

32-character Base58 credential ID returned after public-key registration.

X-API-Timestampstring required

Unix timestamp in seconds; tolerance is ±300 seconds.

X-API-Noncestring required

16 cryptographically random bytes encoded as unpadded Base64URL; fresh on every attempt.

Digeststring required

SHA-256= followed by standard padded Base64 of SHA-256 of exact request body bytes. Required even for an empty body; included in the signing string.

Authorizationstring required

Use Ed25519 signature="BASE64_SIGNATURE", where BASE64_SIGNATURE is the standard padded Base64 signature. See /docs/en/4-authorization for the exact signing string.

Request body

client_referencestring string

Client Reference

request_idstring string required

request id (unique)

order_descstring string

Order description

currencystring string

Order currency (USD, EUR, GBP, CAD, SGD, AUD)

amountstring string required

Order amount. The minimum is greater than 0.1 for crypto acquiring; fiat payment methods require at least 16.

merchant_aliasstring string

customized merchant alias (optional)

expires_ininteger

Time to live in seconds (e.g., 3600 for 1 hour, 0 for default order expires time)

success_urlstring string

Success redirect Url

failure_urlstring string

Failure redirect Url

pay_methodsinteger[]

Enabled payment modes for this order (optional, inherits from merchant config if not specified)

emailstring string

Payer email (optional)

Response

client_referencestring string
request_idstring string
order_idstring string

Order id

checkout_urlstring string

Checkout url

tokenstring string

Token

Changes

    • breaking

      added the new required header request parameter X-API-Key-ID

    • breaking

      added the new required header request parameter X-API-Nonce

    • breaking

      added the new required header request parameter X-API-Timestamp

    • breaking

      the header request parameter Authorization became required

    • breaking

      the header request parameter Digest became required

    • warning

      deleted the header request parameter Date

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status