Search Overlay

API Endpoints

The API endpoint (URI or URL) must point to either the Test or Production (live) environment.

  • Test API endpoint:
    For example:
  • Production API endpoint:
    For example:

API Endpoint Patterns

The API endpoints conform to this pattern:

You may need to replace the following elements:

Element Usage


Use test for a test transaction. Remove test for a live transaction.
v1 Used for the API version.

The following table lists the Hosted Payments API requests:

API Request Used To Endpoint Pattern
Process an Order

Process an order using the hosted payment page. Options available include:

  • Process an Order with a Silent Post
  • Create a Profile with an Order
  • Process an Order with a Payment Token.


Cancel an Order Cancel an order


Cancel a Held Order Cancel an order with a transaction status of held.


Resend an Order Callback Trigger the re-sending of the callback if, for any reason, you do not receive it.


Process a Rebill Using an Order ID

Process a rebill against your customer’s card, using a previously successful order ID.

The rebill can be immediate or can be set up to run at a future date.


Process a Rebill Using a Profile Process a rebill against your customer’s card, using a customer profile.


Get an Order Status Get the status of an order request.


Update a Held Order Update the transaction status of an order that is held, to either success or cancelled.


Update a Rebill Order Update the transaction status of a Rebill order, where the rebill has not yet been processed.


Get an Order Report Get a list of recently created or processed orders.


Refund an Order Refund an order that has been processed (i.e. where the funds have been settled to the merchant's account).


Settle an Order Settle an order (capture the funds on an original authorization), used by merchants who delay settlement until products or services have been delivered.


Cancel a Settlement Cancel the settlement, if a settlement request has been sent but the amount has not yet been settled.


Issue an Original Credit Issue an Original Credit using an Order ID


Issue an Original Credit using a Profile Issue an Original Credit using an Profile ID


In the examples above, replace order_id with the unique order ID returned when setting up the initial order.

On this Page