v1

latestOpenAPI 3.0.02026-07-2335196124.2 KB
Place order

Place orders using the full range of available payment methods (with examples).

Create a new orders and collect payments from shoppers using catalog products (products defined in your Control Panel) or dynamic products (products created via API on the fly).

For orders placed with Credit Card, the 3DS Secure flow needs to be covered by redirecting the shoppers to complet the security flow. The full process is detailed here.

For a full list of list of common errors that may arise when using placing order calls via API version 6 here.

When placing a new order it generates unique order reference numbers for all orders (purchases). You can use this parameter RefNo sent in the body to retry authorizations for orders with failed transactions by changing the payment method.

post/orders/

Headers

X-Avangate-Authenticationstring required
Acceptstring required

Request body

Languagestring
Countrystring
CustomerIPstring
Sourcestring
WSOrderstring
ExternalCustomerReferencestring
Currencystring
Promotionsstring[]
BillingCycleResetboolean

Only used when the request type is "Place an order with manual renewal". Licence renewal will start immediately upon processing the new order, resetting the billing cycle.

Response

Created

RefNostring

Unique order reference number.

OrderNointeger
ExternalReferencestring
Statusstring

The status of the order (e.g. AUTHRECEIVED, PENDING, COMPLETE).

ApproveStatusstring
VendorApproveStatusstring
Languagestring
Sourcestring
WSOrderstring
OrderDatestring