Overview
This documentation will show how to use the Subuno API.
For merchants using Yahoo Stores, Shopify, or BigCommerce, installation takes a few minutes and does not require the Subuno API.
We also have a plugin for Woocommerce. For other shopping cart users (e.g. Magento, osCommerce, PrestaShop, etc.) available, modules developed by third parties may be availalble. Please contact support@subuno.com for more details.
Sending Queries
Queries are made through GET requests. Each query must contain your Subuno API key and at least one transaction data field.
You can send Subuno as many (or as few) fields. Sending more fields to Subuno will ensure that all your customized rules are run properly, thereby returning to you a more accurate risk profile based on your rules.
https://api.subuno.com/v1/?source=api&apikey=xxxx&bill_zip=10023&ip_addr=24.24.24.24&t_id=12345
Responses from Queries
Responses are serialized in JSON and include an action flag (accept, reject or manual review), a unique reference code and a transaction id (this is the order id you send us). You may use the reference code to access that particular order within Subuno to see the complete details.
{
"action": "accept",
"ref_code": "EPIM7XNYZU",
"t_id": 13425
}
Order Status Update
When an order’s status changes during manual review (e.g. changing an order marked for review to reject), an order status webhook automatically sends a status update to a designed URL. To identify the order, the reference code (ref_code) and your order id (t_id), if provided, will be included in the webhook. You may specify the designation in your settings.
https://www.yourserver.com/subuno-update/ \ t_id=7d3n89wn&ref_code=I1YG8Q6ZOG&action=accept
API Input Fields
While you can send as few as one field, sending more data ensures higher accuracy.
Core Parameters
| Parameter | Description |
|---|---|
apikey | Your Subuno API license key. |
source | Always set to "API". |
t_id | Your internal order ID. |
ip_addr | Customer's IP address. |
price | Total transaction price. |
Billing & Shipping
| Parameter | Description |
|---|---|
customer_name | First and last name. |
email | Customer email address. |
bill_zip | Billing zip code. |
ship_street1 | Shipping street address. |