Fraud check API Integration

get

https://uat.txshield.payshield.ai/fraud-check

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For fraud integrations only, where payment processing is not required. Transaction can be sent to {URL}/api/v1/index.php/{SID}/fraudcheck.

The URL, SID and RCODE will be provided during onboarding process. The RCODE will be used in the FraudCheck API to create the hash string.

📘
error_* will only be there if status = EXC

Form Data

sid

int32

required

ID of site

hash

string

required

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

timestamp

string

required

Timestamp value used in the hash e.g. 1234568995265421

tid

string

Merchant reference

card_type

string

required

Type of card(visa/mastercard)

card_no

int32

required

The card number

card_cvv

int32

required

The card 3/4 digit verification code

card_exp_month

string

required

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

card_exp_year

string

required

4 digit year i.e. 2016

card_name

string

required

The name printed on the card

threeDSecure

string

json string containing 3ds2 check values

firstname

string

required

First name of the customer

lastname

string

required

Last name of the customer

string

required

Email of the customer

phone

string

Phone of the customer

address

string

Billing street address

suburb_city

string

Billing suburb or city

state

string

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

country

string

Billing country, ISO 3166 2 digit code.

postcode

string

Billing postcode/zipcode.

shipping_address

string

Shipping street address

shipping_suburb_city

string

Shipping suburb or city

shipping_state

string

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

shipping_country

string

Shipping country, ISO 3166 2 digit code

shipping_postcode

string

Shipping postcode/zipcode

amount

string

enum

required

Amount, needs to be in 2 decimals

Allowed:

currency

string

required

Transaction currency, ISO 3 letter code

Responses

📘

200200

400400