{"id":514,"date":"2021-07-30T14:28:04","date_gmt":"2021-07-30T14:28:04","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=514"},"modified":"2021-07-30T14:28:04","modified_gmt":"2021-07-30T14:28:04","slug":"request","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/direct-integration\/request\/","title":{"rendered":"Request"},"content":{"rendered":"

Below are the details for the request message to initiate a transaction where the card details are submitted.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Tag\/Attribute<\/span> Name<\/span><\/span><\/p>\n<\/td>\n

\n

Data<\/span><\/span><\/p>\n

Type<\/span><\/span><\/p>\n<\/td>\n

\n

Max<\/span><\/span><\/p>\n

Length<\/span><\/span><\/p>\n<\/td>\n

\n

Mandatory<\/span><\/span><\/p>\n<\/td>\n

\n

Comments<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

PaymentMessage<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

MerchantAuthentication<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

MerchantID<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The gateway account<\/span> merchant ID issued (not to be<\/span> confused<\/span> with the<\/span> MMS<\/span><\/span><\/p>\n

username)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Password<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> gateway<\/span> account<\/span><\/span><\/p>\n

password<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

TransactionDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Amount<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> transaction<\/span> amount<\/span> in<\/span> minor<\/span> currency<\/span> \u2013<\/span> e.g.<\/span> for<\/span><\/span><\/p>\n

\u00a310.00, it must be submitted<\/span> as 1000. Zero (0) is only<\/span> supported<\/span> where<\/span> the<\/span><\/span><\/p>\n

TransactionType<\/span> is<\/span> PREAUTH.<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CurrencyCode<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

3<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

ISO<\/span> 4217<\/span> e.g.<\/span> GBP:<\/span> 826<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

OrderID<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

A merchant side ID for the<\/span> order \u2013 primarily used to for<\/span> determining<\/span> duplicate<\/span><\/span><\/p>\n

transactions<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

OrderDescription<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

256<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n

(N\/A)<\/span><\/span><\/p>\n<\/td>\n

\n

A description<\/span> for<\/span> the<\/span> order<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

AuthCode<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (See<\/span><\/span><\/p>\n

comment)<\/span><\/span><\/p>\n<\/td>\n

\n

This<\/span> provides<\/span> an<\/span> auth code<\/span><\/span><\/p>\n

for<\/span> the<\/span> transaction<\/span> is<\/span> one<\/span> was<\/span> obtained<\/span> manually<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ThreeDSecurePassthroughData<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

EnrolmentStatus<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

1<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The status value from the<\/span> VeRes<\/span> (CH.enrolled)<\/span> \u2013<\/span> can<\/span> be<\/span><\/span><\/p>\n

either<\/span> Y,<\/span> N<\/span> or<\/span> U<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

AuthenticationStatus<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

1<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Thestatusvaluefromthe<\/span><\/span><\/p>\n

PaRes(TX.status)<\/span> \u2013<\/span> canbe<\/span> either<\/span> Y, N, U<\/span> or<\/span> A<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n<\/colgroup>\n\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

\n<\/td>\n

\n

ECI<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

2<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The 2 digital electronic<\/span> commerce indicator from the<\/span> PaRes (TX.eci). Must be<\/span> present<\/span> if<\/span> AuthenticationStatus<\/span> is<\/span> either<\/span> Y<\/span><\/span><\/p>\n

or<\/span> A<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

AuthenticationValue<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

28<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

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

Y<\/span> or<\/span> A<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

TransactionIdentifier<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

36<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The transaction identifier (xid<\/span> for<\/span> 3DSv1<\/span> or<\/span> DSTransID<\/span> for<\/span><\/span><\/p>\n

3DSv2)<\/span> for<\/span> the<\/span> transaction<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ThreeDSecureVersion<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

5<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> raw<\/span> 3D<\/span> Secure<\/span> version<\/span><\/span><\/p>\n

value<\/span> of<\/span> the<\/span> authentication<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

MessageDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

TransactionType<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

Must<\/span> be<\/span> either<\/span> SALE,<\/span> REFUND<\/span><\/span><\/p>\n

or<\/span> PREAUTH<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

LineItemDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

SalesTaxAmount<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The sales tax amount in minor<\/span> currency \u2013 e.g. for \u00a310.00, it<\/span> must be submitted<\/span> as<\/span> 1000<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

SalesTaxDescription<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span> description<\/span> of<\/span> the<\/span> sales<\/span> tax<\/span><\/span><\/p>\n

(e.g.<\/span> \u201cVAT<\/span> (20%)\u201d<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

LineItems<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

LineItem<\/strong><\/span> (multiple)<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Quantity<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> quantity<\/span> of<\/span> a<\/span> single line<\/span><\/span><\/p>\n

item<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Amount<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The amount of a single line<\/span> item in minor currency \u2013 e.g.<\/span> for \u00a310.00, it must be<\/span> submitted<\/span> as<\/span> 1000<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Description<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> description<\/span> of<\/span> a<\/span> single<\/span><\/span><\/p>\n

line item<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ThreeDSecureBrowserDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

DeviceCategory<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Determines<\/span> the<\/span> category<\/span> for<\/span> the customer\u2019s browser \u2013<\/span> 0<\/span> for<\/span> computer<\/span> grade browser,<\/span><\/span><\/p>\n

1<\/span> for a<\/span> mobile<\/span> device<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

AcceptHeaders<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The headers that the device’s<\/span> browser<\/span> accepts<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

\n<\/td>\n

\n

UserAgent<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> user<\/span> agent<\/span> string<\/span> for<\/span> the<\/span><\/span><\/p>\n

device’s<\/span> browser<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

TransactionControl<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

EchoCardType<\/span><\/span><\/p>\n<\/td>\n

\n

B<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (False)<\/span><\/span><\/p>\n<\/td>\n

\n

Instructs the gateway to<\/span> include the card type of the<\/span> transaction in the message<\/span> response<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

EchoAVSCheckResult<\/span><\/span><\/p>\n<\/td>\n

\n

B<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (False)<\/span><\/span><\/p>\n<\/td>\n

\n

Instructs<\/span> the<\/span> gateway<\/span> to<\/span><\/span><\/p>\n

include the AVS<\/span> results for<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

the transaction<\/span> in the<\/span><\/span><\/p>\n

message<\/span> response<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

EchoCV2CheckResult<\/span><\/span><\/p>\n<\/td>\n

\n

B<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (False)<\/span><\/span><\/p>\n<\/td>\n

\n

Instructs the gateway to<\/span> includethe CV2 results for<\/span> the<\/span> transaction<\/span> in<\/span> the<\/span><\/span><\/p>\n

message<\/span> response<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

EchoAmountReceived<\/span><\/span><\/p>\n<\/td>\n

\n

B<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (False)<\/span><\/span><\/p>\n<\/td>\n

\n

Instructs the gateway to<\/span> include the amount that was<\/span> passed to it in the message<\/span> response<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

EchoExternalData<\/span><\/span><\/p>\n<\/td>\n

\n

B<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (False)<\/span><\/span><\/p>\n<\/td>\n

\n

Instructs the gateway to<\/span> include the transaction<\/span> identifiers of the bank\u2019s<\/span> external<\/span> system<\/span> in<\/span> the<\/span><\/span><\/p>\n

message<\/span> response<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

DuplicateDelay<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

3<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span> (60)<\/span><\/span><\/p>\n<\/td>\n

\n

Sets the amount of time (in<\/span> seconds) that any orders to<\/span> the same gateway account<\/span> with the same OrderID and<\/span> CardNumber should be<\/span> rejected<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

AVSOverridePolicy<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No (As<\/span> set<\/span> in<\/span><\/span><\/p>\n

MMS)<\/span><\/span><\/p>\n<\/td>\n

\n

Sets<\/span> an<\/span> override<\/span> AVS<\/span> checking<\/span><\/span><\/p>\n

policy for this transaction.<\/span> (See<\/span> Appendix<\/span> 3<\/span> for<\/span> details)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

CV2OverridePolicy<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No (As<\/span> set<\/span> in<\/span><\/span><\/p>\n

MMS)<\/span><\/span><\/p>\n<\/td>\n

\n

Sets<\/span> an<\/span> override<\/span> CV2<\/span> checking<\/span><\/span><\/p>\n

policy for this transaction.<\/span> (See<\/span> Appendix<\/span> 3<\/span> for<\/span> details)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

ThreeDSecureOverridePolicy<\/span><\/span><\/p>\n<\/td>\n

\n

B<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

\n

No (As<\/span> set<\/span> in<\/span><\/span><\/p>\n

MMS)<\/span><\/span><\/p>\n<\/td>\n

\n

Sets an override for 3D<\/span> Secure checking for this<\/span> transaction<\/span><\/span><\/p>\n

FALSE = Do not perform 3D<\/span> Secure enrolment check<\/span> TRUE<\/span> =<\/span> Perform<\/span> 3D<\/span> Secure<\/span><\/span><\/p>\n

enrolment<\/span> check<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

CardDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

CardName<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> name<\/span> on<\/span> the<\/span> customer\u2019s<\/span><\/span><\/p>\n

card<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

CardNumber<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

20<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> customer\u2019s<\/span> card<\/span> number<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

ExpiryDate<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n<\/tbody>\n

\n

\n<\/td>\n

\n

Month<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

2<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The month of the expiry date<\/span> in 2 digit numeric format \u2013 e.g.<\/span> for July, must be submitted as<\/span> 07<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

\n<\/td>\n

\n

Year<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

2<\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/span><\/span><\/p>\n<\/td>\n

\n

The year of the expiry date in<\/span> 2 digit numeric format \u2013 e.g.<\/span> for 2007, must be submitted<\/span> as<\/span> 07<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CV2<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

4<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The security number (also<\/span> called CVV or CVV2) printed on<\/span> the customer\u2019s card \u2013 usually<\/span> the last 3 or 4 digits printed on<\/span> the<\/span> signature<\/span> strip<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

IssueNumber<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

2<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The issue number printed on<\/span> the<\/span> customer\u2019s<\/span> card<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CustomerDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

BillingAddress<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address1<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n

line 1<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address2<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

line 2<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address3<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n

line 3<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address4<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n

line 4<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

City<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n

city<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

State<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n

state<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PostCode<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Customer\u2019s<\/span> billing<\/span> address<\/span><\/span><\/p>\n

post code<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CountryCode<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

3<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

ISO<\/span> 3166-1<\/span> e.g.<\/span> United<\/span><\/span><\/p>\n

Kingdom:<\/span> 826<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

EmailAddress<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The email address of the<\/span> customer \u2013 NOTE: anything<\/span> passedinhereisvalidatedas<\/span> an<\/span> emailaddress,soanything<\/span> passed<\/span> in<\/span> must<\/span> be<\/span> avalid<\/span><\/span><\/p>\n

email<\/span> address<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PhoneNumber<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

30<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> customer\u2019s<\/span> phone<\/span><\/span><\/p>\n

number<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CustomerIPAddress<\/span><\/span><\/p>\n<\/td>\n

\n

I<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The IP address of the<\/span> customer(NOTtheIPaddress<\/span> of<\/span> themerchant\u2019swebsite).<\/span><\/span><\/p>\n

This<\/span> is<\/span> usedto<\/span> determine<\/span> the<\/span><\/span><\/p>\n

customer\u2019s<\/span> country<\/span> of<\/span> origin.<\/span> The format<\/span> isxxx.xxx.xxx.xxx<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

DateOfBirth<\/span><\/span><\/p>\n<\/td>\n

\n

D<\/span><\/span><\/p>\n<\/td>\n

\n

10<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The date<\/span> of<\/span> birth<\/span> of the<\/span><\/span><\/p>\n

customer.Mustbeinthe<\/span> format<\/span> YYYY-MM-DD<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PrimaryAccountDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Name<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> name<\/span> of<\/span> the primary<\/span><\/span><\/p>\n

account<\/span> holder<\/span> (used<\/span> for<\/span> MCC<\/span> 6012<\/span> accounts<\/span> only)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

\n<\/td>\n

\n

AccountNumber<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The account number of the<\/span> primary account holder (used<\/span> for<\/span> MCC<\/span> 6012<\/span> accounts<\/span> only)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

DateOfBirth<\/span><\/span><\/p>\n<\/td>\n

\n

D<\/span><\/span><\/p>\n<\/td>\n

\n

10<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The<\/span> date<\/span> of<\/span> birth<\/span> of<\/span> the<\/span><\/span><\/p>\n

primary<\/span> account<\/span> holder<\/span> (used<\/span> for<\/span> MCC<\/span> 6012<\/span> accounts<\/span> only)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

AddressDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PostCode<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The post code of the primary<\/span> account<\/span> holder<\/span> (used<\/span> for<\/span> MCC<\/span> 6012<\/span> accounts<\/span> only)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ShippingDetails<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

ShippingAddress<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address1<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

line 1<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address2<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

line 2<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address3<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

line 3<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Address4<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

line 4<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

City<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

city<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

State<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

state<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PostCode<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> address<\/span><\/span><\/p>\n

post code<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CountryCode<\/span><\/span><\/p>\n<\/td>\n

\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

3<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

ISO<\/span> 3166-1<\/span> e.g.<\/span> United<\/span><\/span><\/p>\n

Kingdom:<\/span> 826<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Name<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> name<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

EmailAddress<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

The email address of the<\/span> shipping recipient \u2013 NOTE:<\/span> anything passed in here is<\/span> validatedasanemailaddress,<\/span> so<\/span> anythingpassedinmust<\/span><\/span><\/p>\n

be a valid<\/span> email<\/span> address<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PhoneNumber<\/span><\/span><\/p>\n<\/td>\n

\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

30<\/span><\/span><\/p>\n<\/td>\n

\n

No<\/span><\/span><\/p>\n<\/td>\n

\n

Shipping<\/span> recipient\u2019s<\/span> phone<\/span><\/span><\/p>\n

number<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

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…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[2,71],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/514"}],"collection":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/comments?post=514"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/514\/revisions"}],"predecessor-version":[{"id":515,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/514\/revisions\/515"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=514"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=514"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=514"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}