Skip to navigation
REST RPC APIOrders

Finalize processing Order

View as Markdown

Finalizes an order whose placement response was PROCESSING rather than a final result. Once processing is complete on your side, send the final order placement response here. The order must have status 10 (processing), 13 (connection error), or 9 (pending batch response).

A 400 response carries an error_code:

  • 1: a required field is missing.
  • 2: response_xml isn’t valid XML.
  • 3: the order’s status doesn’t allow finalizing. If the order is still pending placement (status 11), retry is true and you can send the request again later.
  • 4: response_xml is valid XML but doesn’t follow the order placement response format.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Path parameters

order_idstringRequired
Unique order ID

Request

This endpoint expects an object.
processing_response_idstringRequired

The order ID your system returned with the PROCESSING response

response_xmlstringRequired

The final order placement response, in the XML format described in Recurring Order Placement

idempotency_keystringRequired
A unique key for this response

Response

200
orderstringOptional
Public ID of the order
merchantstringOptional
Public ID of the merchant
statusintegerOptional

Order status code after the response is processed. See Order Status Codes.

display_statusstringOptional
Name of the order status
error_codeinteger or nullOptional

null on success. See the endpoint description for the 400 codes.

error_messagestring or nullOptional

null on success, otherwise what went wrong

retrybooleanOptional
Whether you can send this request again later
currency_units_per_merchant_currency_unitdoubleOptional

Errors

400
Bad Request Error
404
Not Found Error