API Endpoints
The API endpoint (URI or URL) must point to either the Test or Production (live) environment.
- Test API endpoint: https://api.test.netbanx.com
For example: https://api.test.netbanx.com/hosted/monitor - Production API endpoint: https://api.netbanx.com
For example: https://api.netbanx.com/hosted/monitor
API Endpoint Patterns
The API endpoints conform to this pattern:
https://api.test.netbanx.com/hosted/v1/orders
You may need to replace the following elements:
| Element | Usage |
|---|---|
test | 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:
| POST/hosted/v1/orders |
| Cancel an Order | Cancel an order | DELETE/hosted/v1/orders/order_id |
| Cancel a Held Order | Cancel an order with a transaction status of held. | PUT/hosted/v1/orders/order_id |
| Resend an Order Callback | Trigger the re-sending of the callback if, for any reason, you do not receive it. | GET/hosted/v1/orders/order_id/resend_callback |
| 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. | POST/hosted/v1/orders/order_id |
| Process a Rebill Using a Profile | Process a rebill against your customer’s card, using a customer profile. | POST/hosted/v1/ordersorder_id |
| Get an Order Status | Get the status of an order request. | GET/hosted/v1/orders/order_id |
| Update a Held Order | Update the transaction status of an order that is held, to either success or cancelled. | PUT/hosted/v1/orders/order_id |
| Update a Rebill Order | Update the transaction status of a Rebill order, where the rebill has not yet been processed. | PUT/hosted/v1/orders/order_id |
| Get an Order Report | Get a list of recently created or processed orders. | GET/hosted/v1/orders/orders?num=num&start=start |
| Refund an Order | Refund an order that has been processed (i.e. where the funds have been settled to the merchant's account). | POST/hosted/v1/orders/order_id/refund |
| 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. | POST/hosted/v1/orders/order_id/settlement |
| Cancel a Settlement | Cancel the settlement, if a settlement request has been sent but the amount has not yet been settled. | DELETE/hosted/v1/orders/order_id/settlement |
| Issue an Original Credit | Issue an Original Credit using an Order ID | POST/hosted/v1/orders/order_id |
| Issue an Original Credit using a Profile | Issue an Original Credit using an Profile ID | POST/hosted/v1/orders/order_id |
In the examples above, replace order_id with the unique order ID returned when setting up the initial order.