Request

Below are the details for the request message to initiate a transaction where the card details are submitted.

Tag/Attribute Name

Data

Type

Max

Length

Mandatory

Comments

PaymentMessage

Yes

MerchantAuthentication

Yes

MerchantID (attribute)

A

15

Yes

The gateway account merchant ID issued (not to be confused with the MMS

username)

Password (attribute)

A

15

Yes

The gateway account

password

TransactionDetails

Yes

Amount (attribute)

N

15

Yes

The transaction amount in minor currency e.g. for

£10.00, it must be submitted as 1000. Zero (0) is only supported where the

TransactionType is PREAUTH.

CurrencyCode (attribute)

N

3

Yes

ISO 4217 e.g. GBP: 826

OrderID

A

50

Yes

A merchant side ID for the order – primarily used to for determining duplicate

transactions

OrderDescription

A

256

No

(N/A)

A description for the order

AuthCode

A

No (See

comment)

This provides an auth code

for the transaction is one was obtained manually

ThreeDSecurePassthroughData

No

EnrolmentStatus (attribute)

A

1

Yes

The status value from the VeRes (CH.enrolled) can be

either Y, N or U

AuthenticationStatus (attribute)

A

1

No

Thestatusvaluefromthe

PaRes(TX.status) canbe either Y, N, U or A

ECI (attribute)

A

2

No

The 2 digital electronic commerce indicator from the PaRes (TX.eci). Must be present if AuthenticationStatus is either Y

or A

AuthenticationValue

N

28

No

The authentication value from the PaRes.ForVerified By Visa, this is known as CAVV (Cardholder Authentication Verification Value), for MasterCard SecureCode,itisknownas UCAF (Universal Cardholder Authentication Field). It must be present if AuthenticationStatus is either

Y or A

TransactionIdentifier

A

36

No

The transaction identifier (xid for 3DSv1 or DSTransID for

3DSv2) for the transaction

ThreeDSecureVersion

A

5

No

The raw 3D Secure version

value of the authentication

MessageDetails

Yes

TransactionType (attribute)

Yes

Must be either SALE, REFUND

or PREAUTH

LineItemDetails

No

SalesTaxAmount (attribute)

N

15

No

The sales tax amount in minor currency – e.g. for £10.00, it must be submitted as 1000

SalesTaxDescription

A

50

No

A description of the sales tax

(e.g. “VAT (20%)”

LineItems

No

LineItem (multiple)

No

Quantity (attribute)

N

15

No

The quantity of a single line

item

Amount (attribute)

N

15

No

The amount of a single line item in minor currency – e.g. for £10.00, it must be submitted as 1000

Description

A

100

No

The description of a single

line item

ThreeDSecureBrowserDetails

No

DeviceCategory (attribute)

N

No

Determines the category for the customer’s browser – 0 for computer grade browser,

1 for a mobile device

AcceptHeaders

A

No

The headers that the device’s browser accepts

UserAgent

A

No

The user agent string for the

device’s browser

TransactionControl

No

EchoCardType

B

No (False)

Instructs the gateway to include the card type of the transaction in the message response

EchoAVSCheckResult

B

No (False)

Instructs the gateway to

include the AVS results for

the transaction in the

message response

EchoCV2CheckResult

B

No (False)

Instructs the gateway to includethe CV2 results for the transaction in the

message response

EchoAmountReceived

B

No (False)

Instructs the gateway to include the amount that was passed to it in the message response

EchoExternalData

B

No (False)

Instructs the gateway to include the transaction identifiers of the bank’s external system in the

message response

DuplicateDelay

N

3

No (60)

Sets the amount of time (in seconds) that any orders to the same gateway account with the same OrderID and CardNumber should be rejected

AVSOverridePolicy

No (As set in

MMS)

Sets an override AVS checking

policy for this transaction. (See Appendix 3 for details)

CV2OverridePolicy

No (As set in

MMS)

Sets an override CV2 checking

policy for this transaction. (See Appendix 3 for details)

ThreeDSecureOverridePolicy

B

No (As set in

MMS)

Sets an override for 3D Secure checking for this transaction

FALSE = Do not perform 3D Secure enrolment check TRUE = Perform 3D Secure

enrolment check

CardDetails

Yes

CardName

A

100

Yes

The name on the customer’s

card

CardNumber

N

20

Yes

The customer’s card number

ExpiryDate

Yes

Month (attribute)

N

2

Yes

The month of the expiry date in 2 digit numeric format – e.g. for July, must be submitted as 07

Year (attribute)

N

2

Yes

The year of the expiry date in 2 digit numeric format – e.g. for 2007, must be submitted as 07

CV2

N

4

No

The security number (also called CVV or CVV2) printed on the customer’s card – usually the last 3 or 4 digits printed on the signature strip

IssueNumber

N

2

No

The issue number printed on the customer’s card

CustomerDetails

No

BillingAddress

No

Address1

A

100

No

Customer’s billing address

line 1

Address2

A

50

No

Customer’s billing address

line 2

Address3

A

50

No

Customer’s billing address

line 3

Address4

A

50

No

Customer’s billing address

line 4

City

A

50

No

Customer’s billing address

city

State

A

50

No

Customer’s billing address

state

PostCode

A

50

No

Customer’s billing address

post code

CountryCode

N

3

No

ISO 3166-1 e.g. United

Kingdom: 826

EmailAddress

A

100

No

The email address of the customer – NOTE: anything passedinhereisvalidatedas an emailaddress,soanything passed in must be avalid

email address

PhoneNumber

A

30

No

The customer’s phone

number

CustomerIPAddress

I

15

No

The IP address of the customer(NOTtheIPaddress of themerchant’swebsite).

This is usedto determine the

customer’s country of origin. The format isxxx.xxx.xxx.xxx

DateOfBirth

D

10

No

The date of birth of the

customer.Mustbeinthe format YYYY-MM-DD

PrimaryAccountDetails

No

Name

A

100

No

The name of the primary

account holder (used for MCC 6012 accounts only)

AccountNumber

A

50

No

The account number of the primary account holder (used for MCC 6012 accounts only)

DateOfBirth

D

10

No

The date of birth of the

primary account holder (used for MCC 6012 accounts only)

AddressDetails

No

PostCode

A

50

No

The post code of the primary account holder (used for MCC 6012 accounts only)

ShippingDetails

No

ShippingAddress

No

Address1

A

100

No

Shipping recipient’s address

line 1

Address2

A

50

No

Shipping recipient’s address

line 2

Address3

A

50

No

Shipping recipient’s address

line 3

Address4

A

50

No

Shipping recipient’s address

line 4

City

A

50

No

Shipping recipient’s address

city

State

A

50

No

Shipping recipient’s address

state

PostCode

A

50

No

Shipping recipient’s address

post code

CountryCode

N

3

No

ISO 3166-1 e.g. United

Kingdom: 826

Name

A

100

No

Shipping recipient’s name

EmailAddress

A

100

No

The email address of the shipping recipient – NOTE: anything passed in here is validatedasanemailaddress, so anythingpassedinmust

be a valid email address

PhoneNumber

A

30

No

Shipping recipient’s phone

number

Next Post
Introduction
Previous Post
Response
Menu