AuthOnly API

post

https://vt-staging.omnipaytech.com:4430?/?authonly

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

app_id

string

required

Defaults to WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_key

string

required

Defaults to 53PWdki5U0PGSVhRnVoFsfVSbuDutsA8

Merchant APP Key (Alphanumeric - Length of 32 chars)

epi

string

required

Defaults to 2203082193

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

mtype

string

required

Defaults to 0100

Message type for 0100 is authorization request (Pre Auth)

amount

double

required

Defaults to 567.67

Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)

pan

int32

required

Defaults to 4111111111111111

Customer card number 15 to 19 digits

expiry_date

date

required

Defaults to 1224

Card expiry date, Accepted expiry MMYY & MM/YY (The expiration date must be exactly 4 characters long, consisting of a 2-digit month (with a leading zero if necessary) followed by a 2-digit year (e.g., "0526"))

cvv

string

Defaults to 999

Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)

surchargeIndicator

int32

required

Defaults to 1

The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added

food_amount

double

Defaults to 0

Currency $(Eg. 00.00) - Food amount should be less than to transaction amount

tax

double

Defaults to 0

Tax amount - Currency $ (Eg. 00.00)

city_tax

double

Defaults to 0

City tax amount - Currency $ (Eg. 00.00)

reduced_tax

double

Defaults to 0

City tax amount - Currency $ (Eg. 00.00)

custom_fee

double

Defaults to 0

Additional fee of surcharge amount - Currency $ (Eg: 10.00)

card_holder_name

string

Name of the cardholder - Alphabet (Max length of 25 chars)

s_customerName

string

Shipping address customer name - Alphabet (Max length of 25 chars)

b_customerName

string

Billing address customer name - Alphabet (Max length of 25 chars)

recursivePaymentId

int32

Customer unique recursive payment id (subscription id) (Numeric - Max length of 11 chars)

avs

int32

Defaults to 1

Address verification service (zip, street address - Numeric length of 1 chars)

uid

string

A unique id of the request, A client can send any number of 10 digit

recursivePayment

boolean

Defaults to false

Is recursive payment true or false

phone

int32

Customer phone number- 10 digit Numeric (Ex: 5247896523)

string

Customer email id - Varchar (Ex: [email protected], Max length of 50 chars)

username

string

Customer user name (Alphanumeric length of 25 chars)

s_street_no

int32

Shipping address street number - Number with hyphen (Ex: 1-95)

s_street_name

string

Shipping address street name - Alphanumeric (Length of 50 chars)

s_unit

string

Shipping address unit (Ex. block, apartment) - Max length of 25 chars

s_city

string

Shipping address city should be allowed max 50 chars of string (Ex: New York, San Francisco)

s_state

string

Shipping address state 2 chars of capital (Ex: New York - NY, California - CA)

s_zip

int32

Shipping address zip code should be 5 digits (Numeric - Ex: 10001, 90002)

b_street_no

int32

Billing address street number - Number with hyphen (Ex: 1-95)

b_street_name

string

Billing address street name - Alphanumeric (Length of 50 chars)

b_unit

string

Billing address unit (Ex. block, apartment) - Max length of 25 chars

b_city

string

Billing address city should be allowed max 50 chars of string (Ex: New York, San Francisco)

b_state

string

Billing address state 2 chars of capital (Ex: New York - NY, California - CA)

b_zip

int32

Billing address zip code should be 5 digits (Numeric - Ex: 10001, 90002)

orderId

int32

Transaction order id for sale and auth (Length of max 11 chars)

invoicenumber

int32

Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)

dataset_id

int32

Line item against created dataset id (Numeric -Max length of 20 chars, Ex: 364, 370 )

orderdescription

string

Add the order description - Optional (Alphanumeric - Max length of 50 chars)

validateCard

string

Defaults to 0

Validate the card default set as 1

userid

int32

Defaults to 15625

Customer user id - Numeric max length of 11 chars

surchargeRemoved

int32

Defaults to 0

To remove the surcharge fee set value 0 else set 1

Responses

200200

400400