Developers

Welcome to the Subuno API

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. For some shopping cart users (e.g. CubeCart, Magento, osCommerce, PrestaShop, and Zen Cart) available, modules developed by third parties may be availalble. Please contact us for more details.

The Subuno API sends order information and receives an “Accept/Reject/Manual Review” response based on the rules and settings of your account. Sample libraries to call the API are available in Java, PHP, Python, .NET, and Ruby. Visit our Github Page 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. While you are welcome to send Subuno as many (or as few) fields as possible, 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/?apikey=xxxxxxxxxx&bill_zip=10023&ip_addr=24.24.24.24&t_id=12345

This query sends a Subuno license key, billing zip code, IP address, and order number to Subuno.

Responses from queries

Responses are serialized in JSON and include an action flag (accept, reject or manual review) based on your setting, a unique reference code, your merchant order (if it was sent as part of the query). 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
}

https://app.subuno.com/transaction/EPIM7XNYZU

Order status update

When an order’s status changes during manual review (i.e. changing an order marked for review to either accept or reject), an order status webhook automatically sends a status update to a designed URL. To identify the transaction, 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.

http://www.yourserver.com/subuno-update/t_id=7d3n89wn&ref_code=I1YG8Q6ZOG&action=accept

This query the order number, reference code, and updated action to URL example. Order status changed from review to accept.


API Variables

Subuno API Outputs

Query Response
Action flag (action)

The action flag (accept, reject or review) determined by the business rules for your account.

Reference ID (ref_code)

Subuno generated unique ID for each transaction.

Transaction ID (t_id)

Your internal transaction ID (if sent as an input).

{
“action”:”accept”,
“ref_code”: “EPIM7XNYZU”,
“t_id”: 13425
}

Subuno API Inputs

The Subuno API requires a valid license key and at least one input. Sending more information will allow you take advantage of more rule settings and fraud prevention tools.

Query Information
Subuno license key (apikey)

Your Subuno API license key.

Platform information (source)

How information is sent to Subuno. Please put “API” as your source.

https://api.subuno.com/v1/?apikey=8adfAsd6sXwt&
source=API
Order Information
Transaction ID (t_id)

Your internal transaction ID.

IP address (ip_addr)

IP address of the customer.

Total price (price)

Total price of the transaction.

Bank Identification Number (iin)

The first six digits of the customer’s credit card which identifies the issuing ban.

AVS response (avs_response)

AVS response code returned by your processor.

CVV response (cvv_response)

CVV response code returned by your processor.

Issuer phone number (issuer_phone)

The customer service number of the issuing bank of the credit card used.

t_id=120987xy1
ip_addr=24.24.24.24
price=129.99
iin=325435
avs_response=YYY
cvv_response=N
issuer_phone=18009879087
Order Information
Transaction ID (t_id)

Your internal transaction ID.

t_id=120987xy1
IP address (ip_addr)

IP address of the customer.

ip_addr=24.24.24.24
Total price (price)

Total price of the transaction.

price=129.99
Bank Identification Number (iin)

The first six digits of the customer’s credit card which identifies the issuing ban.

iin=325435
AVS response (avs_response)

AVS response code returned by your processor.

avs_response=YYY
CVV response (cvv_response)

CVV response code returned by your processor.

cvv_response=N
Issuer phone number (issuer_phone)

The customer service number of the issuing bank of the credit card used.

issuer_phone=18009879087
Billing Information
Customer name (customer_name)

First and last name of the customer.

Phone number (phone)

Phone number of the customer.

E-mail (email)

E-mail address of the customer.

Company (company)

Customer’s company/organization.

Billing address 1 (bill_street1)

Line one of the billing address.

Billing address 2 (bill_street2)

Line 2 of the billing address.

Billing city (bill_city)

City of the billing address.

Billing state/region (bill_state)

State of the billing address.

Billing country (bill_country)

The two digit country code of the billing country.

Billing zip/postal code (bill_zip)

The zip code or the postal code of the billing address.

customer_name=Johne Doe
phone=2127658798
email=john@johndoe.com
company=JD Limited
bill_street1=1 Main Street
bill_street2=#432
bill_city=New York
bill_state=NY
bill_country=US
bill_zip=10056
Shipping Information
Recipient’s name (ship_name)

First and last name of the recipient.

Recipient’s phone number (ship_phone)

Phone number of the recipient.

Recipient’s e-mail (ship_email)

E-mail address of the recipient.

Shipping address 1 (ship_street1)

Line one of the shipping address.

Shipping address 2 (ship_street2)

Line 2 of the shipping address.

Shipping city (ship_city)

City of the shipping address.

Shipping state/region (ship_state)

State of the shipping address.

Shipping country (ship_country)

The two digit country code of the shipping country.

Shipping zip/postal code (ship_zip)

The zip code or the postal code of the shipping address.

ship_name=Jane Doe
ship_phone=2127879879
ship_email=jane@doe.com
ship_street1=234 First Avenue
ship_street2=Apt#41
ship_city=New City
ship_state=CA
ship_country=US
ship_zip=90827
Additional Information
Custom field 1 (custom1)

Field for passing additional information not previously defined.

Custom field 2 (custom2)

Field for passing additional information not previously defined.

Custom field 3 (custom3)

Field for passing additional information not previously defined.

custom1=
custom2=
custom3=