Chapter 5 – SimpleTransact Method

When integrating payments, there are situations where extra data is not necessary to the processing environment. A typical example of this is Retail. For this reason, Nuvei offers a simplistic transaction request to accommodate circumstances where minimum data will handle processing needs.

Section 5.1 - Service Location: link

For SOAP connections:

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

For standard HTTPS connections:

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

SimpleTransact Input Parameters:

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

 

Parameter Name

Opt/Req/ Conditional

Max Length

Description

UserName

R

32

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

TraceNum

R

14

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

Recommended to include on receipt.

SerialNum

R

10

Unique Serial Number of the Payment device.

TimeOut

R

2

Set in seconds. Maximum is 90 seconds.

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

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

Format: $$$$$.CC

OrigRefNum

O

4

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

CashBackAmt

O/C

8

Applies to Debit processing only

Casback amount format: $$$$$.CC

TipAmt

O

8

The amount should be included to the total amount. For reporting and receipt purposes only. See Adjust to perform a standard tip at a later time.

InvNum

O

16

Length varies by processor.

ECRRefNum

R

16

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

AuthCode

R1/C

10

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

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.

OrigTransDate

C

8

For use when performing a VOID. Use along with OrigRefNum and OrigTranhsTime.

Format: yyyyMMdd  

OrigTransTime

C

6

For use when performing a VOID. Use along with OrigRefNum and OrigTranhsDate.

Format: hhmmss

ExtData

O

VAR

Used for processing Fleet. Currently not supported.

 

 

Section 5.1.1 - SimpleTransact Response Data Definitions link

O = Optional, R = Required, C = Conditional

Parameter Name

Opt/Req/ Conditional

Max Length

Description

ResultCode

R

6

Transaction Result Code

ResultTxt

O/C

32

Transaction Result Text

*Only returned when using 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 ISV

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 terminals within a group.

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.

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

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 host returned balance.

ExtraBalance

C

8

The cardholder’s balance amount.

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

CardType

O/C

16

Displays Card Type. Varies by Payment Processor

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.

 





Parameter Name

Opt/Req/ Conditional

Max Length

Description

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 TransTypes, such as ADJUST, VOID, POSTAUTH, CAPTURE, and REPEATSALE.

BatchNum

O

32

Host Batch Number.

Response varies by Processor.

SigFileName

O/C

Var

File Name of the Captured Signature

The filename format is “Timestamp_RefNum”.

The file type is File. If SigSavePath was not set, it will be saved at <install dir>

\ img\ receipts\

If SigSavePath was set,

it will be saved at < DestinationPath>\

It will also convert the raw signature data to an image with PNG automatically. This image file name as same as the raw signature file name.

RawResponse

O/C

VAR

Gateway Response – if applicable

ExtData

   

Currently Not Supported

 

 

Section 5.2 - SimpleTransact XML Schema link

Section 5.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/SimpleTransact" <?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> <SimpleTransact xmlns="https://secure.spweblink.com/"> <UserName>string</UserName> <Password>string</Password> <PosID>string</PosID> <SerialNum>string</SerialNum> <TraceNum>string</TraceNum> <TimeOut>string</TimeOut> <TenderType>string</TenderType> <TransType>string</TransType> <Amount>string</Amount> <CashBackAmt>string</CashBackAmt> <TipAmt>string</TipAmt> <OrigRefNum>string</OrigRefNum> <InvNum>string</InvNum> <ECRRefNum>string</ECRRefNum> <AuthCode>string</AuthCode> <Force>string</Force> <OrigTransDate>string</OrigTransDate> <OrigTransTime>string</OrigTransTime> <ExtData>string</ExtData> </SimpleTransact> </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> <SimpleTransactResponse xmlns="https://secure.spweblink.com/"> <SimpleTransactResult> <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> </SimpleTransactResult> </SimpleTransactResponse> </soap:Body> </soap:Envelope>

Section 5.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> <SimpleTransact xmlns="https://secure.spweblink.com/"> <UserName>string</UserName> <Password>string</Password> <PosID>string</PosID> <SerialNum>string</SerialNum> <TraceNum>string</TraceNum> <TimeOut>string</TimeOut> <TenderType>string</TenderType> <TransType>string</TransType> <Amount>string</Amount> <CashBackAmt>string</CashBackAmt> <TipAmt>string</TipAmt> <OrigRefNum>string</OrigRefNum> <InvNum>string</InvNum> <ECRRefNum>string</ECRRefNum> <AuthCode>string</AuthCode> <Force>string</Force> <OrigTransDate>string</OrigTransDate> <OrigTransTime>string</OrigTransTime> <ExtData>string</ExtData> </SimpleTransact> </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> <SimpleTransactResponse xmlns="https://secure.spweblink.com/"> <SimpleTransactResult> <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> </SimpleTransactResult> </SimpleTransactResponse> </soap12:Body> </soap12:Envelope>

Section 5.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/SimpleTransact?UserName=string&Password=string&PosID=string&SerialNum=string&TraceNum=string&TimeOut=string&TenderType=string&TransType=string&Amount=string&CashBackAmt=string&TipAmt=string&OrigRefNum=string&InvNum=string&ECRRefNum=string&AuthCode=string&Force=string&OrigTransDate=string&OrigTransTime=string&ExtData=string HTTP/1.1 Host: demo.spweblink.com 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 5.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/SimpleTransact HTTP/1.1 Host: demo.spweblink.com Content-Type: application/x-www-form-urlencoded Content-Length: length UserName=string&Password=string&PosID=string&SerialNum=string&TraceNum=string&TimeOut=string&TenderType=string&TransType=string&Amount=string&CashBackAmt=string&TipAmt=string&OrigRefNum=string&InvNum=string&ECRRefNum=string&AuthCode=string&Force=string&OrigTransDate=string&OrigTransTime=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 5.2.5 - JSON Format link

POST /Service/PosService.asmx/SimpleTransact HTTP/1.1 Host: demo.spweblink.com Content-Type: application/json; charset=utf-8 Content-Length: length { "SimpleTransact": { "UserName": "string", "Password": "string", "PosID": "string", "SerialNum": "string", "TraceNum": "string", "TimeOut": "string", "TenderType": "string", "TransType": "string", "Amount": "string", "CashBackAmt": "string", "TipAmt": "string", "OrigRefNum": "string", "InvNum": "string", "ECRRefNum": "string", "AuthCode": "string", "Force": "string", "OrigTransDate": "string", "OrigTransTime": "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.