Fraud Check

Create a fraudcheck

POST<?=PROTOCOL?>://<?=SITE_DOMAIN?>/api/v1/index.php/{sid}/fraudcheck

Path parameters

sid*integer

ID of site

Body

multipart/form-data

hash*string

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

timestamp*string

timestamp value used in the hash e.g. 1234568995265421

tidstring

Merchant reference

card_type*integer (int64)

type of card(visa/mastercard)

card_no*integer (int64)

The card number or the bin

card_exp_month*string

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

card_exp_year*string

4 digit year i.e. 2016

card_name*string

The name printed on the card

card_ccv*number

Card CCV

bank_namestring

The name of the bank

bank_phonestring

Bank phone number

routing_nostring

Bank routing number

mobilestring

Mobile number

useragentstring

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

browseragentstring

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

dynamic_descriptorstring

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

fingerprintsessionstring

device fingerprint (Unique identifier for the session)

threeDSecurestring

json string containing 3ds2 check values

device_infostring

json string containing device information check values

firstname*string

First name of the customer.

lastname*string

Last name of the customer.

email*string

Email of the customer.

phonestring

Phone of the customer.

addressstring

Billing street address

suburb_citystring

Billing suburb or city

statestring

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

countrystring

Billing country, ISO 3166 2 digit code.

postcodestring

Billing postcode/zipcode.

ship_addressstring

Shipping street address

ship_suburb_citystring

Shipping suburb or city

ship_statestring

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

ship_countrystring

Shipping country, ISO 3166 2 letter code.

ship_postcodestring

Shipping postcode/zipcode.

amount*any

Amount

currency*string

Transaction currency, ISO 3 letter code

uipstring

users ip address

Response

200default

Fraudcheck result

Body

application/json

sidinteger (int64)

sid of site

commentstring

comment

tidstring

Merchant reference

card_issuerstring

Name of the card issuer

txidinteger (int64)

Fraud check transaction id

statusstring

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstring

FRAUDCHECK

amountnumber

The amount specified in the request

currencystring

The currency specified in the request

pay_methodstring

Payment method specified in request

errorarray of object

cardbindataarray of object

fraud_checksstring

Json string with the details of fraudcheck

Request

JavaScriptCurlPythonHTTP

const response = await fetch('<?=PROTOCOL?>://<?=SITE_DOMAIN?>/api/v1/index.php/{sid}/fraudcheck', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "hash": "text",
      "card_type": 0,
      "card_no": 0,
      "card_ccv": 0,
      "card_exp_month": "text",
      "card_exp_year": "text",
      "card_name": "text",
      "timestamp": "text",
      "firstname": "text",
      "lastname": "text",
      "email": "text",
      "currency": "text"
    }),
});
const data = await response.json();

Response

200default

{
  "sid": 0,
  "comment": "text",
  "tid": "text",
  "card_issuer": "text",
  "txid": 0,
  "status": "text",
  "tx_action": "text",
  "amount": 0,
  "currency": "text",
  "pay_method": "text",
  "error": [
    {
      "type": "text",
      "code": "text",
      "msg": "text"
    }
  ],
  "cardbindata": [
    {
      "bin": "text",
      "card_type": "text",
      "bank_name": "text",
      "country": "text",
      "phone": "text",
      "type": "text",
      "level": "text",
      "www": "text",
      "date_added": "text"
    }
  ],
  "fraud_checks": "text"
}