Worldpay Hosted Payments Integration Quick Start Guide

1. Overview

This document provides basic information for developers integrating hosted payments.

1.1. What Is Hosted Payments?

Hosted Payments allows an existing merchant with WorldPay credentials (AccountID, AccountToken, AcceptorID, ApplicationID) to enable their web server/e-commerce solution for payment acceptance by allowing the collection manually-typed credit card information into a secure WorldPay-hosted page. This credit card information can then be processed for a Sale, a Pre-Auth, or it can be tokenized for future payment requests.

1.2. IPS Payment Bridge

To use Hosted Payments, WorldPay must first certify the solution. To enable IPS customers immediate access to Hosted Payments without requiring them to certify their own web solution, IPS has certified a Payment Bridge with WorldPay. IPS customers can utilize the payment bridge to execute certified Hosted Payment requests with WorldPay. This is accomplished by posting transaction requests to https://hpb.idtechproducts.com/execute (or https://uat.hpb.idtechproducts.com/execute for test transactions) with all required and optional parameters. The IPS Payment Bridge will then forward to WorldPay using certified logic. Requests can be made using NameValuePairs in the URL, or by formatting the body as a JSON packet and posting it to the target URL.

2. Transaction Parameters

The following list is of all parameters that can be passed to the IPS Payment Bridge. These parameters are defined by WorldPay.

3. Transaction Setup Types

The TransactionSetup parameter is required and can contain a valid value from 1-20. The types of transaction are as follows:

• CreditCardSale = 1: Credit Card Sale; requires Amount > 0.00.
• CreditCardAuthorization = 2: Credit Card Pre-Auth; requires Amount > 0.00.
• CreditCardAVSOnly = 3: AVS Check Only. Requires Amount = 0.00.
• PaymentAccountCreate = 7: Requests a payment token to be returned from the entered credit card info.
• PaymentAccountUpdate = 8: Updates a previous payment token.
• Completion = 10: Completion from a previous pre-auth. Requires TransactionID.
• Reversal = 11: Reversal from a previous transaction. Requires TransactionID.
• Void = 12: Void from a previous transaction. Requires TransactionID.
• Credit = 13: Credit from card. Requires credit card number.
• PaymentAccountCreateTransID = 14: Create payment token from previous transaction. Requires TransactionID.
• PaymentAccountQuery = 15: Query payment token.
• PaymentAccountRecordCount = 16: Payment token count.
• PaymentAccountRecordTokenReport = 17: Payment token report.
• PaymentAccountRecordDelete = 18: Delete payment token.
• PaymentAccountSale = 19: Perform sale from a payment token.
• PaymentAccountAuthorization = 20: Perform a pre-auth from payment token.
• Refund = 21: Refund from a previous transaction. Requires TransactionID.

4. Request Format: Name Value Pairs (NVP)

The request format is as follows (UAT for test transactions):

https://uat.hpb.idtechproducts.com/execute?<param1=val>&<param2=val>&<paramX=val>

https://hpb.idtechproducts.com/execute?<param1=val>&<param2=val>&<paramX=val>

The parameters should include, but not limited to:

The ReturnURL must be defined as a page on the merchant web service that will process the response. The response will be as follows.

<ReturnURL>?param1=val&<param2=val>&...<paramX=val>

5. Transaction Example: Name Value Pairs (NVP)

Example Credit Card Sale transaction for $16.00, IPS test credentials, requiring CVV and will use AVS, with an auto-return url defined as Google. Note: the example uses a UAT URL because this is a test transaction.

https://uat.hpb.idtechproducts.com/execute?isTest=1&ReturnURL=https://www.google.com&AutoReturn=1&AccountToken=E1EB3EFB049DFB599F1CB454E1CFC4FD14BF90BCE74456AE9E9490D7D609B466C81A3801&AcceptorID=364798674&AccountID=1188346&TransactionSetup=1&Amount=16.00&ReferenceNumber=001&TerminalID=002&LaneNumber=003&BillingAddress1=100&BillingZipcode=33606&CVVRequired=1

Sample response to above, when using Visa 4445222299990007, exp 12/22, CVV 382:

https://www.google.com/?HostedPaymentStatus=Complete&TransactionSetupID=AAEE184C-6779-4572-89B7838D20086146&TransactionID=159599897&ExpressResponseCode=0&ExpressResponseMessage=Approved&AVSResponseCode=Y&CVVResponseCode=M&ApprovalNumber=289337&LastFour=0007&ValidationCode=BD46141F887E4653&CardLogo=Visa&ApprovedAmount=16.00&BillingAddress1=100&BillingZipcode=33606&Bin=444522&Entry=Manual&NetTranID=221860112425222&TranDT=2022-07-05%2011:24:25

6. Request Format: JSON

The request format is as follows (using UAT for test transactions):

Test URL: https://uat.hpb.idtechproducts.com/execute

Live URL: https://hpb.idtechproducts.com/execute

The parameters should include but are not limited to:

The ReturnURL must be defined as a page on the merchant web service that will process the response. The response will be a JSON object.

7. Transaction Example: JSON

Example Credit Card Sale transaction for $16.00, IPS test credentials, requiring CVV and will use AVS, with an auto-return URL defined as Google. Note: the example uses a UAT URL because this is a test transaction.

Test URL: (POST) https://uat.hpb.idtechproducts.com/execute

Body:

{
"isTest": 1,
"ReturnURL": "https://www.google.com",
"AutoReturn": 1,
"AccountToken": "E1EB3EFB049DFB599F1CB454E1CFC4FD14BF90BCE74456AE9E9490D7D609B466C81A3801",
"AcceptorID": "364798674",
"AccountID": "1188346",
"TransactionSetup": 1,
"Amount": "16.00",
"ReferenceNumber": "001",
"TerminalID": "002",
"LaneNumber": "003",
"BillingAddress1": "100",
"BillingZipcode": "33606",
"CVVRequired": 1
}

The request returns a URL. You must redirect your browser to this URL. Example response:

{
"url": "https://certtransaction.hostedpayments.com/?TransactionSetupID=07F1740A-1705-4718-AD6D-8126D6193825"
}

After the transaction is complete, the JSON response object will be returned to the ReturnURL specified in the request. Example:

{
"HostedPaymentStatus": "Complete",
"TransactionSetupID": "AAEE184C-6779-4572-89B7838D20086146",
"TransactionID": "159599897",
"ExpressResponseCode": 0,
"ExpressResponseMessage": "Approved",
"AVSResponseCode": "Y",
"CVVResponseCode": "M",
"ApprovalNumber": "289337",
"LastFour": "0007",
"ValidationCode": "BD46141F887E4653",
"CardLogo": "Visa",
"ApprovedAmount": "16.00",
"BillingAddress1": "100",
"BillingZipcode": "33606",
"Bin": "444522",
"Entry": "Manual",
"NetTranID": "221860112425222",
"TranDT": "2022-07-05%2011:24:25"
}

• Google Docs
• Google Drive
• Download [pdf]
• Download Optimized
• Document:
  • Text
  • References

File Info : application/pdf, 10 Pages, 382.04KB

References

• Worldpay Hosted Payments
• Home Page
• Home Page
• Home Page
• Home Page

Related Documents

	IDTECH VP3350 Quick Start Guide: Mobile Payment Reader Setup and Operation Comprehensive guide to setting up and using the IDTECH VP3350 mobile payment reader. Covers overview, Bluetooth pairing, iOS connectivity, LED indicators, mounting, security, and troubleshooting for the NEO 3 platform.
	IDTECH Augusta Interface Developer's Guide: Firmware Commands & Protocols This developer's guide provides comprehensive technical details for the IDTECH Augusta series payment card readers. It covers low-level firmware commands, communication protocols (ITP, NGA), USB interfaces, EMV L2 data handling, and MagStripe operations, essential for integrators and developers.
	IDTECH SecuRED Encrypted Magstripe Reader JPOS Reference Guide for Windows User Manual This user manual provides comprehensive information on using the IDTECH SecuRED Encrypted Magstripe Reader with JPOS Service Objects for Windows. It covers system requirements, environment setup, testing procedures using POSTest, and a sample code snippet for integrating the reader into applications.