Skip to main content

Order administration (optional)

After an order has been placed, it is time to activate the order rows and perhaps perform returns and adjustments. This is done through our Payments API or manually through our Partner Portal.

Please note

The requests below are done through our Payments API, and to gain access you will need a separate username and sharedKey. Start with the Getting started guide for our Payments API.

Direct payment methods cannot have a total amount larger than the original purchase amount.

Below we have listed a few common calls to our Payments API

CallExplanation
Fully ActivateThe activation occurs when your purchase is ready to be sent to the end customer. This will activate all rows on the order.
Part ActivateThe activation occurs when part of your purchase is ready to be sent to the end customer. This will activate specific rows on the order.
CancelThis is used to cancel all rows on an order that has not yet been activated.
Full CreditUse this when returns occur. This will return the full order.
Part CreditUse this when a partial return occurs. You specify which rows and quantity to return.
AdjustUse this when you want to adjust the amount on an activated order. Direct payment methods cannot have a total amount larger than the original purchase amount.
ReplaceThis is used to change a non-activated order by replacing the contents. Direct payment methods cannot have a total amount larger than the original purchase amount.