Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

Revision history

DateAuthorNotes
18/11/20Colin MacDonaldAdded revision history for change tracking
18/11/20Johan EckbergAdded ExtAuth element to receipt data to indicate that an external (i.e. outside of the terminal) payment process was used












Introduction

This document describes the EPAS protocol implementation in the West payment application.

...

Component

Mult.

Rule

Usage

PrintRequest

[1..1]

 

Yes

PrintOutput

[1..1]

 

Yes

DocumentQualifier

[1..1]

 

Yes

ResponseMode

[1..1]

Set to 'NotRequired'. Print Response is not required but will be accepted.

Yes

IntegratedPrintFlag

[0..1]

default False. Not allowed if DocumentQualifier is not "CashierReceipt" or "CustomerReceipt".

No

RequiredSignatureFlag

[0..1]

Only included if signature is required. If not included then assume no signature is needed.

Yes

OutputContent

[1..1]

 

Yes

OutputFormat

[1..1]

MessageRef, Text, BarCode, XHTML. Only "Text" is used here.

Yes

PredefindContent

[0..1]

Same as Display.

No

ReferenceID

[1..1]

Same as Display.

 

Language

[0..1]

Same as Display.

 

OutputText

[0..n]

 

Yes

Text

[1..1]

Contains the pre-formatted debug / test receipt. May not be supported in future revisions.

Yes

CharacterSet

[0..1]

Same as Display.

No

Font

[0..1]

Same as Display.

No

StartColumn

[0..1]

Same as Display.

No

Color

[0..1]

Same as Display.

No

CharacterWidth

[0..1]

Same as Display.

No

CharacterHeight

[0..1]

Same as Display.

No

CharacterStyle

[0..1]

Same as Display.

No

Alignment

[0..1]

Same as Display.

No

EndOfLineFlag

[0..1]

Same as Display.

No

OutputXHTML

[0..1]

Same as Display.

No

OutputBarcode

[0..1]

Same as Display.

No

BarcodeType

[0..1]

Same as Display.

 

BarcodeValue

[1..1]

Same as Display.

 

ReceiptData

[1..1]

 

Yes

Message

[0..1]Provided if the receipt is a plain text error message or report, rather than a transaction. 

Transaction

[0..1]

Provided if the receipt data is for a transaction, rather than an error message or report.

 

Status

[0..1]

This field provides the overall status of the transaction (e.g. AUTHORISED, DECLINED, CANCELLED etc).

 

DenialReason

[0..1]

If the transaction was denied then this indicates the reason for the transaction being declined.

 

Message

[0..1]

A plain text message typically used for diagnostic purposes or ad-hoc printed reports rather than for a financial transaction.

 

MerchantData

[1..1]

Merchant data.

 

Name

[0..1]

Merchant name.

 

Address

[0..1]

Merchant address.

 

City

[0..1]

Merchant city.

 

ZipCode

[0..1]

Merchant postal code.

 

PhoneNumber

[0..1]

Merchant phone number.

 

OrganisationNumber

[0..1]

Merchant's organisation number.

 

HelplineNumber

[0..1]

Helpline phone number.

 

BankAgentName

[0..1]

Bank agent.

 

AcquirerReference

[0..1]

Acquirer reference used in clearing.

 

TerminalId

[0..1]

Terminal ID.

 

OperatorId

[0..1]

Operator / cashier ID.

 

StorePay

[0..1]Present only for Svea transactions. For a full interpretation of these data elements the reader should consult Svea documentation to become familiar with the concepts involved. 

Contract

[1..1]  

ContractId

[1..1]The Svea contract ID. 

Confirmed

[1..1]Indicates if the contract has been confirmed or not. 

Approved

[1..1]Indicates if the contrat has been approved or not. 

ApprovedAmount

[1..1]Indicates the value of the contract. 

ReferenceNumber

[1..1]Contract reference number, used in reversals. 

ContractResponseInformation

[1..1]Used only where the contract has been declined. Contains a response that should give information on the reason for the decline. 

LegalContractName

[1..1]The contract name. 

Customer

[0..1]Present if customer information has been acquired. 

Name

[1..1]Customer name. 

SecurityNumber

[1..1]Customer's security / ID number. 

Address

[1..1]Customer's address. 

PostalCode

[1..1]Customer's postal code. 

PostArea

[1..1]Customer's postal area. 

PhoneNumber

[1..1]Customer's phone number. 

Email

[1..1]Customer's email address. 

PaymentPlan

[0..1]Present if a Svea payment plan has been selected. 

Id

[1..1]Payment plan ID. 

Description

[1..1]Payment plan text description. 

StartFee

[1..1]Initial fee for the payment plan. 

MonthlyFee

[1..1]Recurring monthly fee for the payment plan. 

DurationInMonths

[1..1]Length of the payment plan in months. 

MonthlyCost

[1..1]The monthly cost of the payment plan. 

InterestRate

[1..1]The interest rate that applies. 

InterestRateEffective

[1..1]The effective interest rate that applies. 

NumberOfPaymentFreeMonths

[1..1]Number of payment-free months in the payment plan. 

TransactionData

[0..1]

Present if amount data is known in the terminal and if the Message component is not used.

 

Type

[1..1]

There shall be a defined mapping between this transaction type and the SPDH 'Transaction Code'.

 

DateTime

[1..1]

Transaction date and time. (see

JIRA
serverWest bug tracking system
serverId95a678f4-f661-3d7f-94b2-8564f44bc72b
keyWP-1159
for more info on handling date time)Note that the timezone offset may not be valid in this field, depending on the terminal being used.  Westpay Classic terminals do not support timezone changes.

 

CurrencyCode

[1..1]

Currency code supplied as per ISO 4217.

 

CurrencyNum

[1..1]

Currency number as per ISO 4217.

 

Amount

[1..1]

Amount of purchase / refund.

 

CashBack

[0..1]

Cash back amount.

 

Gratuity

[0..1]

Gratuity amount.

 

Vat

[0..1]

VAT amount, included in the Amount value.

 

CashAdvanceCharge

[0..1]Surcharge for a cash advance transaction. 

Total

[0..1]

Combined total.

 

ReferenceNumber

[1..1]

Transaction reference number.

 

AuthorisationData

[0..1]

Present if the Message component is not used.

 

PosEntryMode

[1..1]

See 8.1.2 of CHAOI.

 

IdMethod

[1..1]

See 8.1.3 of CHAOI.

 

Channel

[1..1]

See 8.1.4 of CHAOI.

 

Responder

[1..1]

See 8.1.5 of CHAOI.

 

ResponseCode

[1..1]

See 8.1.6 of CHAOI.

 

FinancialInstitution

[1..1]

See 8.1.7 of CHAOI.

 

BatchNumber

[1..1]

The batch number for the transaction.

 

ApprovalCode

[1..1]

Transaction approval code, if appropriate. Locally-generated approval codes begin with "L".

 

VerifiedByDevice

[0..1]Present and set to "true" if the cardholder was verified by a consumer device. According to VISA requirements the receipt must include the text "Verified by device" if this is the case. 

CardData

[0..1]

Present if a card number has been established.

 

MaskedPan

[1..1]

Masked card number.

 

Name

[1..1]

Card name / type.

 

CreditDebit

[1..1]

If the cardholder was asked to choose between a credit or debit account then this will be set to CREDIT or DEBIT. If this attribute is not included then the cardholder was not asked to choose the account type.

 

PaymentCode

[1..1]

Payment code, may be empty.

 

EmvData

[0..1]

Included for EMV transactions.

 

ApplicationId

[1..1]

The application ID, or AID, is given here.

 

Tvr

[1..1]

Terminal Verification Results.

 

Tsi

[1..1]

Transaction Status Indicator.

 

ResponseCode

[0..1]EMV response code, if available. 

PanSequenceNumber

[1..1]PAN sequence number. 

DCC

[0..1]Included for Dynamic Currency Conversion transactions. 

Provider

[1..1]The DCC service provider. 

Rate

[1..1]Currency conversion rate in decimal. 

Source

[1..1]Source of the conversion rate. 

DateTime

[1..1]Timestamp of the currency conversion. 

Amount

[1..1]Converted transaction amount. 

CurrencyNum

[1..1]ISO 4217 currency number of the converted currency. 

CurrencyCode

[1..1]ISO 4217 currency code of the converted currency. 

Exponent

[1..1]Number of digits following the decimal point in this currency. 

MarkUp

[1..1]The conversion charge / mark up as a percentage. This is included in the total. 

Gratuity

[1..1]The value of any gratuity in the converted currency. 

Scheme

[1..1]"V" = Visa, "M" = Mastercard. 

Disclaimer

[1..1]Disclaimer text that must be included in the receipt. 

ExtAuth

[0..1]Available when a alternative payment transaction has been performed, that is a non card transaction. E.g. Swish payment. 

Name

[1..1]Name of the alternative payment method. 

...