v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB

Orders

Create order

Creates a new escrow payment order. buyer_id and seller_id are required (both customers must exist). Once created, the order has a buyer_link and seller_link for the payment flow.

post/orders

Request body

buyer_idinteger

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

seller_idinteger

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

trustee_type'account'

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

namestring required

Order description or product name.

valuenumber float required

Order amount in the account's base currency.

fee_valuenumber float

Fixed platform fee amount. Cannot exceed value.

fee_percentnumber float

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

tagstring

Custom reference tag.

auto_settle0 | 1

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

metadataobject

Arbitrary key-value metadata stored on the order.

imagesstring[]

Array of image URLs for the order.

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.

subscription_idinteger

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

discount_amountnumber

Discount amount to apply to the order value.

discount_coupon_idinteger

Coupon ID to apply as a discount.

discount_wallet_idinteger

Wallet ID to fund a discount credit.

bundleinteger

Bundle ID to associate with this order.

Example request

{
  "buyer_id": 7485,
  "seller_id": 7485,
  "name": "Test New Order",
  "value": 23.77
}

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.

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 €"
}