Sign in
Orders

Create order

Creates a new escrow payment order. An order requires a buyer (buyer_id), optional seller (seller_id), a name, and a value. Once created, the order has a buyer_link and seller_link for the payment flow.

post/orders

Request body

namestring required

Order description or product name.

valuenumber float required

Order amount in the account's base currency.

buyer_idinteger

Customer ID of the buyer. Required unless trustee_type is account.

seller_idinteger

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

fee_valuenumber float

Fixed platform fee amount. Cannot exceed value.

fee_percentnumber float

Platform fee as a percentage.

tagstring

Custom reference tag.

metadataobject

Arbitrary key-value metadata stored on the order.

templateobject

Custom template data for the checkout page.

imagesstring[]

Array of image URLs for the order.

auto_settleboolean

If true, the order is automatically settled after payment without seller confirmation.

buyer_confirmed_urlstring uri

Redirect URL after buyer confirms payment.

buyer_denied_urlstring uri

Redirect URL if buyer cancels payment.

seller_confirmed_urlstring uri

Redirect URL after seller accepts the order.

seller_denied_urlstring uri

Redirect URL if seller rejects the order.

payin_intentsinteger

Maximum number of payin attempts allowed.

payin_method_typesstring[]

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

payin_method_fallbackstring[]

Fallback payment methods if primary types fail.

buyer_billing_idinteger

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

buyer_shipping_idinteger

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

Example request

{
  "name": "Product purchase",
  "value": 150,
  "buyer_id": 42,
  "seller_id": 99,
  "tag": "order-abc-123"
}

Response

Order created

idinteger
selfstring
public_idstring nullable
namestring
descriptionstring nullable
valuenumber

Order amount.

fee_valuenumber nullable
fee_percentnumber nullable
currencystring
amountstring

Formatted amount with currency symbol.

payin_amountstring nullable
payout_amountstring nullable
fee_amountstring nullable
shipping_amountstring nullable
buyer_linkstring uri

Payment URL to share with the buyer.

seller_linkstring uri

Acceptance URL to share with the seller.

qr_linkstring uri

QR code image URL for the order.

status'DRAFT' | 'PENDING_DETAILS' | 'PENDING_PUBLISH' | 'PUBLISHED' | 'ACCEPTED' | 'REJECTED' | 'CANCELLED' | 'RELEASED'
sandboxboolean
status_nicenamestring

Human-readable status label.

imagesstring[]
tagstring nullable
payin_intentsinteger nullable
payin_typesstring[] nullable
payin_fallbackstring[] nullable
metadataobject nullable
templateobject nullable
published_unitsinteger nullable
created_atstring date-time nullable
published_atstring date-time nullable

When the order was paid.

accepted_atstring date-time nullable
shipping_atstring date-time nullable
cancelled_atstring date-time nullable
validated_atstring date-time nullable
released_atstring date-time nullable
connectionsConnections

Hypermedia links to related resources.

Example response

{
  "self": "/2.0/orders/1234",
  "currency": "EUR",
  "amount": "150.00 €"
}

Changes