Fraud Check

post

Create a fraudcheck

Path parameters

sidintegerRequired

ID of site

Body

hashstringRequired

md5 hash of sid+timestamp+amounttotal+currency+rcode e.g. md5('22'.'1234568995265421'.'17.00'.'USD'.'222b6c')

timestampstringRequired

timestamp value used in the hash e.g. 1234568995265421

tidstringOptional

Merchant reference

card_typeinteger · int64Required

type of card(visa/mastercard)

card_nointeger · int64Required

The card number or the bin

card_exp_monthstringRequired

2 digit for the month. Please have leading zeroes e.g. 05

card_exp_yearstringRequired

4 digit year i.e. 2016

card_namestringRequired

The name printed on the card

card_ccvnumberRequired

Card CCV

bank_namestringOptional

The name of the bank

bank_phonestringOptional

Bank phone number

routing_nostringOptional

Bank routing number

mobilestringOptional

Mobile number

useragentstringOptional

string identifying the software acting on behalf of a user to interact with web servers

browseragentstringOptional

string helps identify which browser is being used, what version, and on which operating system

dynamic_descriptorstringOptional

Business name as it appears on the customer's bank statement

fingerprintsessionstringOptional

device fingerprint (Unique identifier for the session)

threeDSecurestringOptional

json string containing 3ds2 check values

device_infostringOptional

json string containing device information check values

firstnamestringRequired

First name of the customer.

lastnamestringRequired

Last name of the customer.

emailstringRequired

Email of the customer.

phonestringOptional

Phone of the customer.

addressstringOptional

Billing street address

suburb_citystringOptional

Billing suburb or city

statestringOptional

Billing state, 2 letter code for US/Canada. Australia should use 2/3 letter codes.

countrystringOptional

Billing country, ISO 3166 2 digit code.

postcodestringOptional

Billing postcode/zipcode.

ship_addressstringOptional

Shipping street address

ship_suburb_citystringOptional

Shipping suburb or city

ship_statestringOptional

Shipping state, 2 letter code for US/Canada. Australia should use 2/3 letter codes.

ship_countrystringOptional

Shipping country, ISO 3166 2 letter code.

ship_postcodestringOptional

Shipping postcode/zipcode.

amountanyRequired

Amount

currencystringRequired

Transaction currency, ISO 3 letter code

uipstringOptional

users ip address

Responses

200

Fraudcheck result

application/json

default

unexpected error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/index.php/{sid}/fraudcheck HTTP/1.1
Host: <?=SITE_DOMAIN?>
Content-Type: multipart/form-data
Accept: */*
Content-Length: 680

{
  "hash": "text",
  "timestamp": "text",
  "tid": "text",
  "card_type": 1,
  "card_no": 1,
  "card_exp_month": "text",
  "card_exp_year": "text",
  "card_name": "text",
  "card_ccv": 1,
  "bank_name": "text",
  "bank_phone": "text",
  "routing_no": "text",
  "mobile": "text",
  "useragent": "text",
  "browseragent": "text",
  "dynamic_descriptor": "text",
  "fingerprintsession": "text",
  "threeDSecure": "text",
  "device_info": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "phone": "text",
  "address": "text",
  "suburb_city": "text",
  "state": "text",
  "country": "text",
  "postcode": "text",
  "ship_address": "text",
  "ship_suburb_city": "text",
  "ship_state": "text",
  "ship_country": "text",
  "ship_postcode": "text",
  "amount": null,
  "currency": "text",
  "uip": "text"
}

{
  "sid": 1,
  "comment": "text",
  "tid": "text",
  "card_issuer": "text",
  "txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "pay_method": "text",
  "error": [],
  "cardbindata": [],
  "fraud_checks": []
}