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.
Request body
Customer ID of the buyer. Required unless auto_settle is 1 or trustee_type is account.
Customer ID of the seller. Required unless auto_settle is 1.
Pass account to use the authenticated account itself as the buyer (the buyer_id is then set automatically).
Order description or product name.
Order amount in the account's base currency.
Fixed platform fee amount. Cannot exceed value.
Platform fee as a percentage. Min 0, max 100.
Custom reference tag.
Set to 1 if there is no seller (e-commerce model). Auto-settles after payment.
Arbitrary key-value metadata stored on the order.
Array of image URLs for the order.
Redirect URL after buyer confirms payment.
Redirect URL if buyer cancels payment.
Redirect URL after seller accepts the order.
Redirect URL if seller rejects the order.
Maximum number of payin attempts allowed.
Allowed payment method types for this order (e.g. ["CARD","BANKWIRE"]).
Fallback payment methods if primary types fail.
Address ID to use as the buyer's billing address.
Address ID to use as the buyer's shipping address.
Associate this order with an existing ACTIVE subscription. The subscription must belong to the buyer_id customer.
Discount amount to apply to the order value.
Coupon ID to apply as a discount.
Wallet ID to fund a discount credit.
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
Order amount.
Formatted amount with currency symbol.
Payment URL to share with the buyer.
Acceptance URL to share with the seller.
QR code image URL for the order.
Human-readable status label.
When the order was paid.
Hypermedia links to related resources.
Example response
{
"self": "/2.0/orders/1234",
"currency": "EUR",
"amount": "150.00 €"
}