Chapter 3 –Transact Method

Section 3.1 - Service Location: link

For SOAP connections:

https://demo.spweblink.com/service/transact.asmx?op=Transact

For standard HTTPS connections:

https://demo.spweblink.com/service/transact.asmx

Description:

The web service is used whenever a transaction is completed via customer Credit Card, Debit Card, EBT Card, Gift or Loyalty Card.

 

Supported by this Method for TransType include:

  • AUTH

  • SALE

  • RETURN

  • VOID

  • POSTAUTH

  • FORCEAUTH

  • REPEATSALE

  • ADJUST

  • INQUIRY

  • ACTIVATE

  • DEACTIVATE

  • RELOAD

  • VOIDSALE

  • VOID_RETURN

  • VOID_AUTH

  • VOID_POSTAUTH

  • VOID_FORCEAUTH

  • REVERSAL

  • WITHDRAWAL

  • ISSUE

  • CASHOUT

  • REPLACE

  • MERGE

  • REPORTLOST

  • REDEEM

  • VERIFY

  • REACTIVATE

  • FORCED_ISSUE

  • FORCED_ADD

  • UNLOAD

  • TOKENIZE

  • INCREMENTAL_AUTH

  • BALANCE_LOCK

  • REDEMPTION_UNLOCK

Processors supporting the restaurant or ‘retail tip’ adjustment function only:

  • ADJUST

Section 3.1.1 - Developer Notes: link

  • Negative values not necessary when processing a Return or Void. Because we know these transactions are not reducing the cardholder’s funds, we handle the processors’ message in the background.

  • Invalid Characters: Some parameters and XML tags contain data that will automatically remove invalid characters from the user-entered data. These parameters and tags include:

    • InvNum

    • Zip

    • Street

    • ExtData: <CustCode>

    • Extdata: <RegisterNum>

    • ExtData: <City>

    • ExtData: <BillToState>

    • ExtData: <PONum>

Section 3.1.2 - Transact Input Parameters: link

O = Optional, R = Required, C = Conditional, R* = Required except on initial Request, R1 = Required on Force transactions.

Parameter Name

Opt/Req/ Conditional

Max Length

Description

UserName

R

32

API user name assigned in the payment server. The user must have an appropriate level of access within the system in order to utilize the web service.

Password

R

32

API Password associated with the user name.

PosID

R

24

Value assigned by Nuvei to identify the ECR/POS Station. Assigned by Nuvei to identify the ECR/POS station

Token

R

64

Value assigned by Nuvei to identify the ISV

TraceNum

R*

14

Unique identifier of the transaction. Assigned by Nuvei’s Web Service at the initial time of transaction.

Recommended to include on receipt.

SerialNum

R

10

Unique Serial Number of the Payment device.

TerminalID

R

24

Identifies individual payment terminal (lane) within a group. Assigned by Nuvei.

TimeOut

R

2

Set in seconds. Maximum is 90 seconds.

WorkstationID

O

24

Value assigned by ISV to the workstation

TransType

R

20

Identifies the type of credit card transaction being made. Valid values can be found with definitions in Appendix A.

TenderType

R

8

Identifies the Tender Type being made. Valid values are:

Credit – Credit Card

Debit – Debit Card

EBT – Electronic Benefits/Food Stamps/Cash Benefits

Gift – Gift Card

Loyalty – Loyalty Card

Amount

R

8

Transaction total amount

Format: $$$$$.CC

OrigRefNum

O

4

Terminal reference number

CashBackAmt

O/C

8

Applies to Debit processing only

Casback amount format: $$$$$.CC

FuelAmt

O

8

Used for Fleet Processing. Not supported at this time.

ClerkID

O

8

Employee Clerk ID.

Can also be used for “ServerID” in restaurant mode.

ZIP

O

9

Cardholder Billing ZIP. Used for manually keyed transactions only. No hyphens allowed.

TipAmt

O

8

The amount should be included in the total amount. For reporting and receipt purposes only.

TipAmt format: $$$$$.CC

See Adjust to perform a standard tip at a later time.

TaxAmt

O

8

The amount should be included to the total amount. The amount should be included to the total amount. For reporting and receipt purposes only.

TaxAmt format: $$$$$.CC

Street1

O

32

Cardholder Billing address

Street2

O

32

Cardholder Billing address line 2

SurchargeAmt

O

8

Convenience fee used for Debit TenderType, amount is added to the cost of a good or service.

This function may be used by utility companies, government agencies, and schools.

SurchargeAmt format: $$$$$.CC

InvNum

O

16

Length varies by processor.

ECRRefNum

R

16

The ECR Reference Number. This is a unique code on the ECR side. It will be returned in the Response message.

ECRTransID

O

19

The ECR Transaction ID, must be unique for each transaction sent to host. Valid for

*Heartland Portico only. It will be mapped to ClientTxnId field in the Heartland Portico API.

AuthCode

R1/C

10

Will be required for a FORCEAUTH. The Merchant receives this when calling the processor’s Voice Authorization Center.

SigSavePath

O

128

The file path taken to save the signature received from the terminal. When it is set, the file will be saved to a user-designated folder. If it is not set, it will be saved to the default folder, which is <install dir>\img\receipts\

Account

O

19

Cloud Connect Web Service does not support any sensitive Payment Account data.

ExpDate

O

4

This is only relevant for payment processors who support Tokenization. It will be required when performing a HostToken transaction.

CVV

O

4

Cloud Connect Web Service does not support any sensitivee Payment Account data.

EBTFoodStampVoucher

C

Boolean

T or F

This is a switch to on/off the EBT Food stamp voucher mode, and this is valid when the TenderType is or “EBT.” Its default value is “F.”

VoucherNum

C

16

Valid for TenderType of EBT

Force

O

T

Force processing of duplicate transactions. If this tag value is set to “T”, the host will not check for duplicates, also it will override the local duplicate check. “T” is the only valid value. Any value other than “T” will be ignored.

FirstName

C

32

First name of card holder.

LastName

C

32

Last name of card holder.

CountryCode

C

2

Two-character ISO 3166 country codes for cardholder. Refer to ISO.org’s Country Code library for the latest standards.

StateCode

C

2

Two Character US State and Canadian Province Codes. Refer to the United States Postal Service for the most recent list.

CityName

C

32

City of cardholder.

EmailAddress

C

64

Email address of cardholder.

CheckSaleType

   

Not supported at this time.

CheckRoutingNum

   

Not Supported at this time.

CheckNum

   

Not Supported at this time.

CheckType

   

Not Supported at this time.

CheckIDType

   

Not Supported at this time.

CheckIDValue

   

Not Supported at this time.

Birth

   

Not Supported at this time.

PhoneNum

   

Not Supported at this time.

TimeStamp

O

14

The Date Time Value. YYYYMMDDhhmmss, if this field is NULL, terminal will use local time. Used for Trace information.

ShiftID

O

8

Shift ID information for the cashier.

CustomerCode

C

32

Used for Level 2 processing with Corporate and Purchase cards. Assigned by POS.

PONum

O

32

Used for Level 2 processing with Corporate or Purchase cards.

Purchase Order number or any reference number used to identify a transaction.

TaxExempt

C

Boolean

0 or 1

Used for Level 2 processing with Corporate or Purchase cards.

Tax Exempt Indicator Values:

“0” = Tax Not Exempt

“1” = Tax Exempt

TaxExemptID

C

12

Used for Level 2 processing with Corporate or Purchase cards.

The Tax-Exempt ID.

MerchantTaxID

C

15

Used for Level 2 processing with Corporate or Purchase cards.

The Merchant TaxID.

DestinationZipCode

C

9

Used for Level 2 processing with Corporate or Purchase cards.

The destination ZIP Code.

ProductDescription

C

40

Used for Level 2 processing with Corporate or Purchase cards.

Product Description

MOTOEcommerceMode

   

Currently not supported.

MOTOEcommerceTransType

   

Currently not supported.

ECommerceSecureType

   

Currently not supported.

MOTOECommerceOrderNum

   

Currently not supported.

Installments

   

Currently not supported.

CurrentInstallment

   

Currently not supported.

TableNum

C

4

Applicable to Restaurant processing.

Table number assigned by POS.

GuestNum

C

4

Applicable to Restaurant processing.

Table number assigned by POS.

SignatureCapture

C

1

The ECR supports signature printing and the terminal supports signature capture. If this field exists, the values below are valid:

‘0’- Do Not Capture,

‘1’- Capture.

Default value = “0”.

TicketNum

C

8

Applicable to Restaurant transaction processing.

Ticket number assigned by POS.

HRefNum

C

32

Host Reference Number or (Transaction UID). This field is host dependent; it can be used to run Void/Return transactions. If this field is returned, it should be printed on the receipt.

TipRequest

C

Boolean

0 or 1

Valid Values:

“0” = Tip Entry Not Required

“1” = Tip Entry Required

SignUploadFlag

C

Boolean

0 or 1

Valid Values:

“0” = Signature Upload Not Required

“1” = Signature Upload Required

If this tag is not sent to the POS, the terminal will upload the signature by default only when signature upload is supported by the host.

ReportStatus

O

Boolean

0 or 1

Whether to report status back.

1: Report.

0: Do not report

TokenRequest

C

Boolean

0 or 1

Retrieves HostToken Value from the processor for a HostToken that has already been generated.

To perform this function, use TransType of CREDIT, TenderType of Sale and populate TokenRequest with 0.

When populating TokenRequest with a value of 1, the payment device will prompt you for the AVS and CVV of the payment card.

Dependent upon processor.

CardType

C

4

Required for Multi-Pay Token transactions depending upon the processor.

CardTypeBitmap

C

4

In order to accept CardType Multi-Pay Tokens, this allows a POS system to control which card types accepted for current command. Processor dependent.

PassthruData

O

256

No longer supported.

ReturnReason

O

Boolean

0 or 1

Reason for a RETURN command:

“0” = General Return

“1” = Adjustment

If the host requires this mandatory field, the default value of “0” will be sent.

OrigTransDate

C

8

Original Transaction Date in YYYYMMDD format. Conditional for some hosts for subsequent transactions after SALE, i.e. RETURN. If the host requires this mandatory field, the current date on terminal will be sent.

OrigPAN

   

Not supported.

OrigExpiryDate

   

Not supported.

OrigTransTime

C

6

Original Transaction Time in HHMMSS format. Conditional for some hosts for subsequent transactions after SALE, i.e. RETURN. If the host requires this mandatory field, the current time on terminal will be sent.

DisProgPrompt

O

8

The default prompt is always on and depending on the bin file. It can be turned off by submitting a “1” in its defined program location.

GatewayID

C

64

This is used to provide a unique value to identify a Gateway or Aggregator. Only valid for TSYS at the moment.

POSEchoData

O

2048

This is user-defined data by the POS developer, the value can be up to 2048 bytes. If the field has been set, the payment terminal will not store and/or parse the contents of this field. The device will just follow the normal logic based off the host’s specifications or the POS developer’s requirement(s) to include in the request message.

GetSign

O

Boolean

0 or 1

Whether to get the signature data:

“0” = Not to Upload

“1” = Capture

The default is 0

EntryModeBitmap

O

8

Allows POS to control the various entry modes programmatically.

ReceiptPrint

O

1

Receipt printing for current command, default as “0 = No Receipt”, it will override the

ReceiptPrint settings in the terminal.

“0” = No Receipt

“1” = Merchant Only

“2” = Customer Only

“3” = Both Merchant/Customer Copy

CPMode

O

1

Card Present Mode for current command:

“0” = Default Value, use terminal’s card present setting.

“1” = Don’t prompt, assume card is present.

“2” = Don’t prompt, assume card is not present.

Odometer

   

Used for processing Fleet. Currently not supported.

VehicleNo

O

 

Used for processing Fleet. Currently not supported.

JobNo

O

 

Used for processing Fleet. Currently not supported.

DriverID

O

 

Used for processing Fleet. Currently not supported.

EmployeeNo

O

 

Used for processing Fleet. Currently not supported.

LicenceID

O

 

Used for processing Fleet. Currently not supported.

DepartmentNo

O

 

Used for processing Fleet. Currently not supported.

UserID

O

 

Used for processing Fleet. Currently not supported.

VehicleID

O

 

Used for processing Fleet. Currently not supported.

HostToken

O/C

16

Used for with Processors who suport Tokenization. This field will be used to pass the Token generated by the payment Processor.

ExtData

O

 

Used for processing Fleet. Currently not supported.

 

Transact Response Data Definitions O = Optional, R = Required, C = Conditional

 

Parameter Name

Opt/Req/ Conditional

Max Length

Description

ResultCode

R

6

Transaction Result Code

ResultTxt

C

   

*Only returned on JSON message format

ResultMsg

R

32

Transaction Result Text

TransType

R

20

Identifies the type of credit card transaction being made. Valid values can be found with definitions in Appendix A.

PosID

R

24

Value assigned by Nuvei to identify the ECR/POS Station. Assigned by Nuvei to identify the ECR/POS station

IPaddress

R

128

IP address of initiating transaction

Port

R

9

Port of the initiating transaction

MacAddress

R

48

Identifies MAC address of payment device

TerminalID

R

24

Identifies individual payment terminal (lane) within a group. Assigned by Nuvei.

Token

R

64

Value assigned by Nuvei to identify the ISV

SerialNum

R

10

Unique Serial number of payment device.

Amount

R

 

Amount requested for approval in original transaction request. Could be different than amount approved.

Format: $$$$$.CC

TraceNum

R

14

Unique identifier of the transaction. Assigned by Nuvei web service at the initial time of transaction.

Recommended to include on receipt.

AuthCode

R

8

Authorization code returned from payment processor

ApprovedAmount

R

8

Amount approved by payment processor

Format: $$$$$.CC

MaskedPan

R

4

Displays last 4 digits of Payment Card Number

RemainingBalance

C

8

The cardholder’s balance amount.

If TenderType is EBT, this equates to the Cash Benefits balance.

If TenderType is Credit (prepaid branded Gift), this equates to the Issuer returned balance. Varies by Card Issuer.

Format: $$$$$.CC

ExtraBalance

C

8

The cardholder’s balance amount.

If TenderType is EBT, this equates to the Food Stamp balance.

Format: $$$$$.CC

CardType

O/C

16

Displays Card Type. Varies by Payment Processor. See Appendix B for values.

 

Parameter Name

Opt/Req/ Conditional

Max Length

Description

AvsResponse

O/C

8

AVS response value returned by Payment Processor

CvResponse

O/C

8

CVV response value returned by Payment Processor

HostCode

R

32

Host reference number.

HostResponse

O/C

8

Host Response or Error Code. Varies based on Payment Processor.

HostMessage

O/C

32

Host or Gateway message. Varies based on Payment Processor or Gateway.

RefNum

O/C

4

Reference Number/Transaction Number

0 < Index <= 5000, normal use data

5001 < Index <=9000, stored database for SAF

9001 < Index <=9999, failed database for SAF

ECRRefNum

O

16

The ECR Reference Number. This is a unique code on the ECR side.

TransDate

R

8

Transaction Date in YYYYMMDD format.

TransTime

R

6

Transaction Time in HHMMSS format.

OrigRefNum

O

4

Terminal reference number, used for follow-on ADJUST, VOID, POSTAUTH, CAPTURE, REPEATSALE, TransTypes. Assigned by Nuvei.

BatchNum

O

32

Host Batch Number.

Response varies by Processor.

RawResponse

O/C

VAR

Gateway Response – if applicable

ExtData

C

VAR

Data included in ExtData varies based on processor feature support, TenderType and other response data. See Appendix C for EMV response data.

Section 3.2 - Transact XML Schema link

Section 3.2.1 - SOAP 1.1 Request and Response link

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

 
POST /Service/PosService.asmx HTTP/1.1 Host: demo.spweblink.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://secure.spweblink.com/Transact" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Transact xmlns="https://secure.spweblink.com/"> <UserName>string</UserName> <Password>string</Password> <WorkstationID>string</WorkstationID> <PosID>string</PosID> <Token>string</Token> <TerminalID>string</TerminalID> <SerialNum>string</SerialNum> <TraceNum>string</TraceNum> <TimeOut>string</TimeOut> <TenderType>string</TenderType> <TransType>string</TransType> <Amount>string</Amount> <CashBackAmt>string</CashBackAmt> <FuelAmt>string</FuelAmt> <ClerkID>string</ClerkID> <Zip>string</Zip> <TipAmt>string</TipAmt> <TaxAmt>string</TaxAmt> <Street>string</Street> <Street2>string</Street2> <SurchargeAmt>string</SurchargeAmt> <PONum>string</PONum> <OrigRefNum>string</OrigRefNum> <InvNum>string</InvNum> <ECRRefNum>string</ECRRefNum> <ECRTransID>string</ECRTransID> <AuthCode>string</AuthCode> <SigSavePath>string</SigSavePath> <Account>string</Account> <ExpDate>string</ExpDate> <CVV>string</CVV> <EBTFoodStampVoucher>string</EBTFoodStampVoucher> <VoucherNum>string</VoucherNum> <Force>string</Force> <FirstName>string</FirstName> <LastName>string</LastName> <CountryCode>string</CountryCode> <StateCode>string</StateCode> <CityName>string</CityName> <EmailAddress>string</EmailAddress> <CheckSaleType>string</CheckSaleType> <CheckRoutingNum>string</CheckRoutingNum> <CheckNum>string</CheckNum> <CheckType>string</CheckType> <CheckIDType>string</CheckIDType> <CheckIDValue>string</CheckIDValue> <Birth>string</Birth> <PhoneNum>string</PhoneNum> <TimeStamp>string</TimeStamp> <ShiftID>string</ShiftID> <CustomerCode>string</CustomerCode> <TaxExempt>string</TaxExempt> <TaxExemptID>string</TaxExemptID> <MerchantTaxID>string</MerchantTaxID> <DestinationZipCode>string</DestinationZipCode> <ProductDescription>string</ProductDescription> <MOTOECommerceMode>string</MOTOECommerceMode> <MOTOECommerceTransType>string</MOTOECommerceTransType> <ECommerceSecureType>string</ECommerceSecureType> <MOTOECommerceOrderNum>string</MOTOECommerceOrderNum> <Installments>string</Installments> <CurrentInstallment>string</CurrentInstallment> <TableNum>string</TableNum> <GuestNum>string</GuestNum> <SignatureCapture>string</SignatureCapture> <TicketNum>string</TicketNum> <HRefNum>string</HRefNum> <TipRequest>string</TipRequest> <SignUploadFlag>string</SignUploadFlag> <ReportStatus>string</ReportStatus> <TokenRequest>string</TokenRequest> <CardType>string</CardType> <CardTypeBitmap>string</CardTypeBitmap> <PassthruData>string</PassthruData> <ReturnReason>string</ReturnReason> <OrigTransDate>string</OrigTransDate> <OrigPAN>string</OrigPAN> <OrigExpiryDate>string</OrigExpiryDate> <OrigTransTime>string</OrigTransTime> <DisProgPrompt>string</DisProgPrompt> <GatewayID>string</GatewayID> <POSEchoData>string</POSEchoData> <GetSign>string</GetSign> <EntryModeBitmap>string</EntryModeBitmap> <ReceiptPrint>string</ReceiptPrint> <CPMode>string</CPMode> <Odometer>string</Odometer> <VehicleNo>string</VehicleNo> <JobNo>string</JobNo> <DriverID>string</DriverID> <EmployeeNo>string</EmployeeNo> <LicenseNo>string</LicenseNo> <JobID>string</JobID> <DepartmentNo>string</DepartmentNo> <CustomerData>string</CustomerData> <UserID>string</UserID> <VehicleID>string</VehicleID> <HostToken>string</HostToken> <ExtData>string</ExtData> </Transact> </soap:Body> </soap:Envelope> HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <TransactResponse xmlns="https://secure.spweblink.com/"> <TransactResult> <ResultCode>string</ResultCode> <ResultTxt>string</ResultTxt> <ResultMsg>string</ResultMsg> <TransType>string</TransType> <IPaddress>string</IPaddress> <PosID>string</PosID> <Port>string</Port> <MacAddress>string</MacAddress> <TerminalID>string</TerminalID> <Token>string</Token> <SerialNum>string</SerialNum> <Amount>string</Amount> <TraceNum>string</TraceNum> <AuthCode>string</AuthCode> <ApprovedAmount>string</ApprovedAmount> <MaskedPAN>string</MaskedPAN> <RemainingBalance>string</RemainingBalance> <ExtraBalance>string</ExtraBalance> <CardType>string</CardType> <AvsResponse>string</AvsResponse> <CvResponse>string</CvResponse> <HostCode>string</HostCode> <HostResponse>string</HostResponse> <HostMessage>string</HostMessage> <RefNum>string</RefNum> <ECRRefNum>string</ECRRefNum> <TransDate>string</TransDate> <TransTime>string</TransTime> <OrigRefNum>string</OrigRefNum> <BatchNum>string</BatchNum> <SigFileName>string</SigFileName> <SignData>string</SignData> <RawResponse>string</RawResponse> <ExtData>string</ExtData> </TransactResult> </TransactResponse> </soap:Body> </soap:Envelope>

Section 3.2.2 - SOAP 1.2 Request and Response link

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

 

POST /Service/PosService.asmx HTTP/1.1 Host: demo.spweblink.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Transact xmlns="https://secure.spweblink.com/"> <UserName>string</UserName> <Password>string</Password> <WorkstationID>string</WorkstationID> <PosID>string</PosID> <Token>string</Token> <TerminalID>string</TerminalID> <SerialNum>string</SerialNum> <TraceNum>string</TraceNum> <TimeOut>string</TimeOut> <TenderType>string</TenderType> <TransType>string</TransType> <Amount>string</Amount> <CashBackAmt>string</CashBackAmt> <FuelAmt>string</FuelAmt> <ClerkID>string</ClerkID> <Zip>string</Zip> <TipAmt>string</TipAmt> <TaxAmt>string</TaxAmt> <Street>string</Street> <Street2>string</Street2> <SurchargeAmt>string</SurchargeAmt> <PONum>string</PONum> <OrigRefNum>string</OrigRefNum> <InvNum>string</InvNum> <ECRRefNum>string</ECRRefNum> <ECRTransID>string</ECRTransID> <AuthCode>string</AuthCode> <SigSavePath>string</SigSavePath> <Account>string</Account> <ExpDate>string</ExpDate> <CVV>string</CVV> <EBTFoodStampVoucher>string</EBTFoodStampVoucher> <VoucherNum>string</VoucherNum> <Force>string</Force> <FirstName>string</FirstName> <LastName>string</LastName> <CountryCode>string</CountryCode> <StateCode>string</StateCode> <CityName>string</CityName> <EmailAddress>string</EmailAddress> <CheckSaleType>string</CheckSaleType> <CheckRoutingNum>string</CheckRoutingNum> <CheckNum>string</CheckNum> <CheckType>string</CheckType> <CheckIDType>string</CheckIDType> <CheckIDValue>string</CheckIDValue> <Birth>string</Birth> <PhoneNum>string</PhoneNum> <TimeStamp>string</TimeStamp> <ShiftID>string</ShiftID> <CustomerCode>string</CustomerCode> <TaxExempt>string</TaxExempt> <TaxExemptID>string</TaxExemptID> <MerchantTaxID>string</MerchantTaxID> <DestinationZipCode>string</DestinationZipCode> <ProductDescription>string</ProductDescription> <MOTOECommerceMode>string</MOTOECommerceMode> <MOTOECommerceTransType>string</MOTOECommerceTransType> <ECommerceSecureType>string</ECommerceSecureType> <MOTOECommerceOrderNum>string</MOTOECommerceOrderNum> <Installments>string</Installments> <CurrentInstallment>string</CurrentInstallment> <TableNum>string</TableNum> <GuestNum>string</GuestNum> <SignatureCapture>string</SignatureCapture> <TicketNum>string</TicketNum> <HRefNum>string</HRefNum> <TipRequest>string</TipRequest> <SignUploadFlag>string</SignUploadFlag> <ReportStatus>string</ReportStatus> <TokenRequest>string</TokenRequest> <CardType>string</CardType> <CardTypeBitmap>string</CardTypeBitmap> <PassthruData>string</PassthruData> <ReturnReason>string</ReturnReason> <OrigTransDate>string</OrigTransDate> <OrigPAN>string</OrigPAN> <OrigExpiryDate>string</OrigExpiryDate> <OrigTransTime>string</OrigTransTime> <DisProgPrompt>string</DisProgPrompt> <GatewayID>string</GatewayID> <POSEchoData>string</POSEchoData> <GetSign>string</GetSign> <EntryModeBitmap>string</EntryModeBitmap> <ReceiptPrint>string</ReceiptPrint> <CPMode>string</CPMode> <Odometer>string</Odometer> <VehicleNo>string</VehicleNo> <JobNo>string</JobNo> <DriverID>string</DriverID> <EmployeeNo>string</EmployeeNo> <LicenseNo>string</LicenseNo> <JobID>string</JobID> <DepartmentNo>string</DepartmentNo> <CustomerData>string</CustomerData> <UserID>string</UserID> <VehicleID>string</VehicleID> <HostToken>string</HostToken> <ExtData>string</ExtData> </Transact> </soap12:Body> </soap12:Envelope> HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <TransactResponse xmlns="https://secure.spweblink.com/"> <TransactResult> <ResultCode>string</ResultCode> <ResultTxt>string</ResultTxt> <ResultMsg>string</ResultMsg> <TransType>string</TransType> <IPaddress>string</IPaddress> <PosID>string</PosID> <Port>string</Port> <MacAddress>string</MacAddress> <TerminalID>string</TerminalID> <Token>string</Token> <SerialNum>string</SerialNum> <Amount>string</Amount> <TraceNum>string</TraceNum> <AuthCode>string</AuthCode> <ApprovedAmount>string</ApprovedAmount> <MaskedPAN>string</MaskedPAN> <RemainingBalance>string</RemainingBalance> <ExtraBalance>string</ExtraBalance> <CardType>string</CardType> <AvsResponse>string</AvsResponse> <CvResponse>string</CvResponse> <HostCode>string</HostCode> <HostResponse>string</HostResponse> <HostMessage>string</HostMessage> <RefNum>string</RefNum> <ECRRefNum>string</ECRRefNum> <TransDate>string</TransDate> <TransTime>string</TransTime> <OrigRefNum>string</OrigRefNum> <BatchNum>string</BatchNum> <SigFileName>string</SigFileName> <SignData>string</SignData> <RawResponse>string</RawResponse> <ExtData>string</ExtData> </TransactResult> </TransactResponse> </soap12:Body> </soap12:Envelope>

Section 3.2.3 - HTTPS GET Request and Response link

The following is a sample HTTPS GET request and response. The placeholders shown need to be replaced with actual values.

GET /Service/PosService.asmx/Transact?UserName=string&Password=string&WorkstationID=string&PosID=string&Token=string&TerminalID=string&SerialNum=string&TraceNum=string&TimeOut=string&TenderType=string&TransType=string&Amount=string&CashBackAmt=string&FuelAmt=string&ClerkID=string&Zip=string&TipAmt=string&TaxAmt=string&Street=string&Street2=string&SurchargeAmt=string&PONum=string&OrigRefNum=string&InvNum=string&ECRRefNum=string&ECRTransID=string&AuthCode=string&SigSavePath=string&Account=string&ExpDate=string&CVV=string&EBTFoodStampVoucher=string&VoucherNum=string&Force=string&FirstName=string&LastName=string&CountryCode=string&StateCode=string&CityName=string&EmailAddress=string&CheckSaleType=string&CheckRoutingNum=string&CheckNum=string&CheckType=string&CheckIDType=string&CheckIDValue=string&Birth=string&PhoneNum=string&TimeStamp=string&ShiftID=string&CustomerCode=string&TaxExempt=string&TaxExemptID=string&MerchantTaxID=string&DestinationZipCode=string&ProductDescription=string&MOTOECommerceMode=string&MOTOECommerceTransType=string&ECommerceSecureType=string&MOTOECommerceOrderNum=string&Installments=string&CurrentInstallment=string&TableNum=string&GuestNum=string&=string&TicketNum=string&HRefNum=string&TipRequest=string&SignUploadFlag=string&ReportStatus=string&TokenRequest=string&CardType=string&CardTypeBitmap=string&PassthruData=string&ReturnReason=string&OrigTransDate=string&OrigPAN=string&OrigExpiryDate=string&OrigTransTime=string&DisProgPrompt=string&GatewayID=string&POSEchoData=string&GetSign=string&EntryModeBitmap=string&ReceiptPrint=string&CPMode=string&Odometer=string&VehicleNo=string&JobNo=string&DriverID=string&EmployeeNo=string&LicenseNo=string&JobID=string&DepartmentNo=string&CustomerData=string&UserID=string&VehicleID=string&HostToken=string&ExtData=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <PosPaymentResult xmlns="https://secure.spweblink.com/"> <ResultCode>string</ResultCode> <ResultTxt>string</ResultTxt> <ResultMsg>string</ResultMsg> <TransType>string</TransType> <IPaddress>string</IPaddress> <PosID>string</PosID> <Port>string</Port> <MacAddress>string</MacAddress> <TerminalID>string</TerminalID> <Token>string</Token> <SerialNum>string</SerialNum> <Amount>string</Amount> <TraceNum>string</TraceNum> <AuthCode>string</AuthCode> <ApprovedAmount>string</ApprovedAmount> <MaskedPAN>string</MaskedPAN> <RemainingBalance>string</RemainingBalance> <ExtraBalance>string</ExtraBalance> <CardType>string</CardType> <AvsResponse>string</AvsResponse> <CvResponse>string</CvResponse> <HostCode>string</HostCode> <HostResponse>string</HostResponse> <HostMessage>string</HostMessage> <RefNum>string</RefNum> <ECRRefNum>string</ECRRefNum> <TransDate>string</TransDate> <TransTime>string</TransTime> <OrigRefNum>string</OrigRefNum> <BatchNum>string</BatchNum> <SigFileName>string</SigFileName> <SignData>string</SignData> <RawResponse>string</RawResponse> <ExtData>string</ExtData> </PosPaymentResult>

Section 3.2.4 - HTTPS POST Request and Response link

The following is a sample HTTPS POST request and response. The placeholders shown need to be replaced with actual values.

 

POST /Service/PosService.asmx/Transact HTTP/1.1 Host: demo.spweblink.com Content-Type: application/x-www-form-urlencoded Content-Length: length UserName=string&Password=string&WorkstationID=string&PosID=string&Token=string&TerminalID=string&SerialNum=string&TraceNum=string&TimeOut=string&TenderType=string&TransType=string&Amount=string&CashBackAmt=string&FuelAmt=string&ClerkID=string&Zip=string&TipAmt=string&TaxAmt=string&Street=string&Street2=string&SurchargeAmt=string&PONum=string&OrigRefNum=string&InvNum=string&ECRRefNum=string&ECRTransID=string&AuthCode=string&SigSavePath=string&Account=string&ExpDate=string&CVV=string&EBTFoodStampVoucher=string&VoucherNum=string&Force=string&FirstName=string&LastName=string&CountryCode=string&StateCode=string&CityName=string&EmailAddress=string&CheckSaleType=string&CheckRoutingNum=string&CheckNum=string&CheckType=string&CheckIDType=string&CheckIDValue=string&Birth=string&PhoneNum=string&TimeStamp=string&ShiftID=string&CustomerCode=string&TaxExempt=string&TaxExemptID=string&MerchantTaxID=string&DestinationZipCode=string&ProductDescription=string&MOTOECommerceMode=string&MOTOECommerceTransType=string&ECommerceSecureType=string&MOTOECommerceOrderNum=string&Installments=string&CurrentInstallment=string&TableNum=string&GuestNum=string&SignatureCapture=string&TicketNum=string&HRefNum=string&TipRequest=string&SignUploadFlag=string&ReportStatus=string&TokenRequest=string&CardType=string&CardTypeBitmap=string&PassthruData=string&ReturnReason=string&OrigTransDate=string&OrigPAN=string&OrigExpiryDate=string&OrigTransTime=string&DisProgPrompt=string&GatewayID=string&POSEchoData=string&GetSign=string&EntryModeBitmap=string&ReceiptPrint=string&CPMode=string&Odometer=string&VehicleNo=string&JobNo=string&DriverID=string&EmployeeNo=string&LicenseNo=string&JobID=string&DepartmentNo=string&CustomerData=string&UserID=string&VehicleID=string&HostToken=string&ExtData=string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <PosPaymentResult xmlns="https://secure.spweblink.com/"> <ResultCode>string</ResultCode> <ResultTxt>string</ResultTxt> <ResultMsg>string</ResultMsg> <TransType>string</TransType> <IPaddress>string</IPaddress> <PosID>string</PosID> <Port>string</Port> <MacAddress>string</MacAddress> <TerminalID>string</TerminalID> <Token>string</Token> <SerialNum>string</SerialNum> <Amount>string</Amount> <TraceNum>string</TraceNum> <AuthCode>string</AuthCode> <ApprovedAmount>string</ApprovedAmount> <MaskedPAN>string</MaskedPAN> <RemainingBalance>string</RemainingBalance> <ExtraBalance>string</ExtraBalance> <CardType>string</CardType> <AvsResponse>string</AvsResponse> <CvResponse>string</CvResponse> <HostCode>string</HostCode> <HostResponse>string</HostResponse> <HostMessage>string</HostMessage> <RefNum>string</RefNum> <ECRRefNum>string</ECRRefNum> <TransDate>string</TransDate> <TransTime>string</TransTime> <OrigRefNum>string</OrigRefNum> <BatchNum>string</BatchNum> <SigFileName>string</SigFileName> <SignData>string</SignData> <RawResponse>string</RawResponse> <ExtData>string</ExtData> </PosPaymentResult>

Section 3.2.5 - JSON Format link

JSON
POST /Service/PosService.asmx/Transact HTTP/1.1 Host: demo.spweblink.com Content-Type: application/json; charset=utf-8 Content-Length: length { "Transact": { "UserName": "string", "Password": "string", "WorkstationID": "string", "PosID": "string", "Token": "string", "TerminalID": "string", "SerialNum": "string", "TraceNum": "string", "TimeOut": "string", "TenderType": "string", "TransType": "string", "Amount": "string", "CashBackAmt": "string", "FuelAmt": "string", "ClerkID": "string", "Zip": "string", "TipAmt": "string", "TaxAmt": "string", "Street": "string", "Street2": "string", "SurchargeAmt": "string", "PONum": "string", "OrigRefNum": "string", "InvNum": "string", "ECRRefNum": "string", "ECRTransID": "string", "AuthCode": "string", "SigSavePath": "string", "Account": "string", "ExpDate": "string", "CVV": "string", "EBTFoodStampVoucher": "string", "VoucherNum": "string", "Force": "string", "FirstName": "string", "LastName": "string", "CountryCode": "string", "StateCode": "string", "CityName": "string", "EmailAddress": "string", "CheckSaleType": "string", "CheckRoutingNum": "string", "CheckNum": "string", "CheckType": "string", "CheckIDType": "string", "CheckIDValue": "string", "Birth": "string", "PhoneNum": "string", "TimeStamp": "string", "ShiftID": "string", "CustomerCode": "string", "TaxExempt": "string", "TaxExemptID": "string", "MerchantTaxID": "string", "DestinationZipCode": "string", "ProductDescription": "string", "MOTOECommerceMode": "string", "MOTOECommerceTransType": "string", "ECommerceSecureType": "string", "MOTOECommerceOrderNum": "string", "Installments": "string", "CurrentInstallment": "string", "TableNum": "string", "GuestNum": "string", "SignatureCapture": "string", "TicketNum": "string", "HRefNum": "string", "TipRequest": "string", "SignUploadFlag": "string", "ReportStatus": "string", "TokenRequest": "string", "CardType": "string", "CardTypeBitmap": "string", "PassthruData": "string", "ReturnReason": "string", "OrigTransDate": "string", "OrigPAN": "string", "OrigExpiryDate": "string", "OrigTransTime": "string", "DisProgPrompt": "string", "GatewayID": "string", "POSEchoData": "string", "GetSign": "string", "EntryModeBitmap": "string", "ReceiptPrint": "string", "CPMode": "string", "Odometer": "string", "VehicleNo": "string", "JobNo": "string", "DriverID": "string", "EmployeeNo": "string", "LicenseNo": "string", "JobID": "string", "DepartmentNo": "string", "CustomerData": "string", "UserID": "string", "VehicleID": "string", "HostToken": "string", "ExtData": "string", "_xmlns": "https://secure.spweblink.com/" } } { " PosPaymentResult": { " PosPaymentResult": { "ResultCode": "string", "ResultTxt": "string", "ResultMsg": "string", "TransType": "string", "IPaddress": "string", "PosID": "string", "Port": "string", "MacAddress": "string", "TerminalID": "string", "Token": "string", "SerialNum": "string", "Amount": "string", "TraceNum": "string", "AuthCode": "string", "ApprovedAmount": "string", "MaskedPAN": "string", "RemainingBalance": "string", "ExtraBalance": "string", "CardType": "string", "AvsResponse": "string", "CvResponse": "string", "HostCode": "string", "HostResponse": "string", "HostMessage": "string", "RefNum": "string", "ECRRefNum": "string", "TransDate": "string", "TransTime": "string", "OrigRefNum": "string", "BatchNum": "string", "SigFileName": "string", "SignData": "string", "RawResponse": "string", "ExtData": "string" }, "_xmlns": "https://secure.spweblink.com/" } }

Need Help?

How can we help you today?  Our team is standing by and just a click away.