https://www.merchantprotector.net/api/ping?api_token={API_TOKEN}
The api_token parameter is required.

Return Value on Success

STATUS: 200
MESSAGE: Holla

Return Value on Failure

STATUS: 404
MESSAGE: Could not find Shop with provided API token

Post order details to Merchant Protector for risk assessment.
REQUIRED
parameters are needed to produce a report.
SUGGESTED
parameters should be included if at all possible.
OPTIONAL
parameters are good to include if you have them (e.g. shipping address information, if you are
shipping physical goods)

Method

POST

URL

https://www.merchantprotector.net/api/orders/new

Parameters

Should be encoded as JSON and passed in the body of the POST request

Name

Required?

Value

api_token

REQUIRED

{API_TOKEN}

browser_ip

REQUIRED

The IP address of the computer that placed the order, in the format "255.255.255.255"

order_id

REQUIRED

Unique ID of the order in your store.
We use this to link back to your store, if your store supports it.

total_price

SUGGESTED

Total price of the order, including shipping and tax.
Should be formatted as a decimal number, with no currency sign. Ie. "123.45"

authorized_at

OPTIONAL

Date and time when the order was created

email_address

SUGGESTED

Email address of the customer that placed the order.

avs_result_code

SUGGESTED

The result of the AVS check on the credit card

cvv_result_code

SUGGESTED

The result of the CVV check on the credit card

credit_card_company

OPTIONAL

The type of credit card (e.g. Visa, MasterCard)

credit_card_bin

SUGGESTED

Six digit number identifying the bank that issued the payment card

number

OPTIONAL

Human readable order number, if different from order_id

billing_address[name]

SUGGESTED

Billing address name

billing_address[address1]

SUGGESTED

Billing street address

billing_address[address2]

OPTIONAL

Billing street address, line 2 if needed

billing_address[city]

SUGGESTED

Billing address city

billing_address[country]

SUGGESTED

Billing address country
Tip: use either country or country_code

billing_address[country_code]

SUGGESTED

Billing address 2 letter country code
Tip: use either country or country_code

billing_address[phone]

SUGGESTED

Billing address phone number

billing_address[province]

SUGGESTED

Billing address state/province

billing_address[province_code]

SUGGESTED

Billing address state/province code

billing_address[zip]

SUGGESTED

Billing address zip or postal code

shipping_address[name]

OPTIONAL

Shipping address name

shipping_address[address1]

OPTIONAL

Shipping street address

shipping_address[address2]

OPTIONAL

Shipping street address, line 2 if needed

shipping_address[city]

OPTIONAL

Shipping address city

shipping_address[country]

OPTIONAL

Shipping address country
Suggestion: use either country or country_code

shipping_address[country_code]

OPTIONAL

Shipping address 2 letter country code
Suggestion: use either country or country_code

shipping_address[name]

OPTIONAL

Shipping address name

shipping_address[phone]

OPTIONAL

Shipping address phone number

shipping_address[province]

OPTIONAL

Shipping address state/province

shipping_address[province_code]

OPTIONAL

Shipping address state/province code

shipping_address[zip]

OPTIONAL

Shipping address zip or postal code

Return Value on Success

STATUS: 200
MESSAGE: Order Imported Successfully

Return Value on Failure

STATUS: 422
MESSAGE: The order already exists
Returned if an order with the same
order_id
parameter is already present.