Riverty Logo

All the Order Management API Calls in more detail

API Documentation

Order Management

POST /api/v3/orders/{orderNumber}/captures

Completes the payment that has been authorized. Typically done when the order is shipped. Can be a full or partial capture of the order amount.

POST /api/v3/orders/{orderNumber}/captures/return-notification

Notifies about a full or partial return registered by the consumer on the merchants web shop.

POST /api/v3/orders/{orderNumber}/refunds

Refunds a partially or fully captured payment.

POST /api/v3/orders/{orderNumber}/voids

Void (cancel) an authorization that has not been captured.

POST /api/v3/orders/{orderNumber}/updateOrder

Change the contents of an Authorized but not Captured order. Use this call to add or remove items in an existing Order, without creating a new orderNumber. You must provide the entire body of the query, in the same format as Authorize, including all Order Items. (If you added an item, Update Order must contain previously Authorized items as well. If you removed an item, Update Order must contain the new full list of Order Items.) If the TotalGrossAmount has increased compared to the Authorize call for this orderNumber, a new Risk Check will be made for the additional amount. If the additional Risk Check returns a rejection, the original Authorize will remain valid.

GET /api/v3/orders/{orderNumber}

Returns the contents of the specified order

GET /api/v3/orders/{orderNumber}/captures/{captureNumber}

Returns all or specific captured payments of the order

GET /api/v3/orders/{orderNumber}/refunds/{refundNumber}

Returns all or specific refunds of the order.

GET /api/v3/orders/{orderNumber}/voids/{voidNumber}

Returns all or specific voided (cancelled) authorizations of the order.

Riverty 2022