VP6300 Hosted Payments
Specifications
- Product: Worldpay Hosted Payments Integration
- Integration Type: Hosted Payments
- Release Date: 13 August 2025
Product Information
The Worldpay Hosted Payments Integration allows merchants with
WorldPay credentials to enable their web server/e-commerce solution
for payment acceptance by collecting credit card information on a
secure WorldPay-hosted page. This information can be processed for
a Sale, a Pre-Auth, or tokenized for future payments.
Transaction Parameters
| Parameter Names | Type | Notes |
|---|---|---|
| AccountID | Required | Needed if Live Transactions (isTest=0) |
Product Usage Instructions
Setting Up Hosted Payments Integration
- Obtain WorldPay credentials: AccountID, AccountToken,
AcceptorID, ApplicationID. - Configure your web server/e-commerce solution to collect credit
card information. - Pass necessary parameters to the IPS Payment Bridge for
processing. - Choose the type of transaction (Sale, Pre-Auth, Tokenization)
based on your requirements.
Processing Transactions
To process a transaction using the Hosted Payments
Integration:
- Ensure all required parameters are included.
- Select the appropriate transaction type.
- Submit the transaction for processing.
- Handle the response accordingly (success or failure).
Frequently Asked Questions (FAQ)
Q: What types of transactions can be processed using Hosted
Payments?
A: Hosted Payments supports Sale, Pre-Auth, Tokenization,
Completion, Void, Refund, and more types of transactions as defined
by WorldPay.
Q: Is AVS (Address Verification System) supported in keyed
transactions?
A: Yes, AVS can be included in keyed transactions if desired.
Billing address details need to be provided for AVS checks.
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 (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.
Hosted Payments QuickStart Guide Rev C 13 August 2025
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.
Parameter Names AccountID
AccountToken AcceptorID License Amount
ReferenceNumber DuplicateCheckDisableFlag
DuplicateOverrideFlag MerchantSuppliedTransactionID
TerminalID LaneNumber
TransactionID
PaymentAccountID
PaymentAccountReferenceNumber
CardNumber ExpirationYear ExpirationMonth AddressEditAllowed
BillingName BillingEmail BillingPhone
BillingAddress1
BillingAddress2 BillingCity
BillingState
BillingZipcode
ShippingName ShippingEmail ShippingPhone ShippingAddress1
Type Required Required Required Conditional Required Required Optional Optional Optional Required Required
Conditional
Conditional
Conditional
Conditional Conditional Conditional
Optional Optional Optional Optional
Optional
Optional Optional Optional
Optional
Optional Optional Optional Optional
Notes
Needed if Live Transactions (isTest=0)
1 = true, 0 = false 1 = true, 0 = false 1 = true, 0 = false
For Completion (Type 10), Void (Type 12), Reverse (Type 11), Create Token (Type 14), Refund (Type 21) Needed when updating PaymentAccount Needed when creating or updating PaymentAccount For Customer Card Credit (Type 13) For Customer Card Credit (Type 13) For Customer Card Credit (Type 13)
Should be included with keyed transactions if AVS desired
Should be included with keyed transactions if AVS desired
Parameter Names ShippingAddress2 ShippingCity ShippingState ShippingZipcode
CommercialCardCustomerCode
TransactionSetup
CVVRequired AutoReturn
CompanyName LogoURL Tagline
WelcomeMessage ReturnURL
ReturnURLTitle OrderDetails
ProcessTransactionTitle CustomCss
Type Optional Optional Optional Optional Optional
Required
Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional
Hosted Payments QuickStart Guide Rev C 13 August 2025
Notes
CreditCardSale = 1 CreditCardAuthorization = 2 CreditCardAVSOnly = 3 PaymentAccountCreate = 7 PaymentAccountUpdate = 8 Completion = 10 Reversal = 11 Void = 12 Credit = 13 PaymentAccountCreateTransID = 14 PaymentAccountQuery = 15 PaymentAccountRecordCount= 16 PaymentAccountRecordTokenReport= 17 PaymentAccountRecordDelete= 18 PaymentAccountSale= 19 PaymentAccountAuthorization= 20 Refund = 21 1 = true, 0 = false 1 = true, 0 = false
1 = true, 0 = false. False by default
Test transactions url:
isTest Optional
https://uat.hpb.idtechproducts.com/
TipAmount
Optional
Live transactions url: https://hpb.idtechproducts.com/
Parameter Names SalesTaxAmount CashBackAmount Page
Embedded
Type Optional Optional Optional
Optional
Hosted Payments QuickStart Guide Rev C 13 August 2025
Notes
1 = true, 0 = false. False by default When true, the displayed form is optimized for mobile browsers
Hosted Payments QuickStart Guide Rev C 13 August 2025
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 o Credit Card Sale; requires Amount > 0.00.
· CreditCardAuthorization = 2 o Credit Card Pre-Auth; requires Amount > 0.00.
· CreditCardAVSOnly = 3 o AVS Check Only. Requires Amount = 0.00.
· PaymentAccountCreate = 7 o Requests a payment token to be returned from the entered credit card info.
· PaymentAccountUpdate = 8 o Updates a previous payment token.
· Completion = 10 o Completion from a previous pre-auth. Requires TransactionID.
· Reversal = 11 o Reversal from a previous transaction. Requires TransactionID.
· Void = 12 o Void from a previous transaction. Requires TransactionID.
· Credit = 13 o Credit from card. Requires credit card number.
· PaymentAccountCreateTransID = 14 o Create payment token from previous transaction. Requires TransactionID.
· PaymentAccountQuery = 15 o Query payment token.
· PaymentAccountRecordCount = 16 o Payment token count.
· PaymentAccountRecordTokenReport = 17 o Payment token report.
· PaymentAccountRecordDelete = 18 o Delete payment token.
· PaymentAccountSale = 19 o Perform sale from a payment token.
· PaymentAccountAuthorization = 20 o Perform a pre-auth from payment token.
· Refund = 21 o Refund from a previous transaction. Requires TransactionID.
Hosted Payments QuickStart Guide Rev C 13 August 2025
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>&<p aramX=val>
https://hpb.idtechproducts.com/execute?<param1=val>&<param2=val>&<param X=val>
The parameters should include, but not limited to:
Parameter
Description
TransactionSetup TransactionType values 1-20.
ReturnURL The web page that will receive the results from the transaction.
1 if the results are automatically returned to the ReturnURL, omit or set to 0 if
AutoReturn results are displayed from WorldPay and another button is required to be clicked
to execute the ReturnURL.
isTest 1 if running test transactions, omit or set to 0 if running live transactions.
Provide AccountID, AccountToken, AcceptorID, ApplicationID (test or live, Credentials
depending on isTest).
License Provide if live transactions.
ReferenceNumber Required unique value. Omit and a random value will be generated.
LaneNumber Required value. Does not have to be unique.
TerminalID Required value. Does not have to be unique.
Amount Required value. Amount to charge.
CVVRequired 1 if CVV must be provided, omit or 0 if CVV is not required to be provided.
BillingAddress1 If AVS street address checking is desired, enter value for BillingAddress1.
BillingZipCode If AVS ZIP code checking is desired, enter a value for BillingZipCode.
If running on mobile platform, setting Embedded=1 will optimize the credit card Embedded collection form for mobile viewing
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>
Hosted Payments QuickStart Guide Rev C 13 August 2025
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://w ww.google.com&AutoReturn=1&AccountToken=E1EB3EFB049DFB599F1CB454E1CFC4F D14BF90BCE74456AE9E9490D7D609B466C81A3801&AcceptorID=364798674&AccountI D=1188346&TransactionSetup=1&Amount=16.00&ReferenceNumber=001&TerminalI D=002&LaneNumber=003&BillingAddress1=100&BillingZipcode=33606&CVVRequir ed=1
Sample response to above, when using Visa 4445222299990007, exp 12/22, CVV 382:
https://www.google.com/?HostedPaymentStatus=Complete&TransactionSetupID =AAEE184C-6779-457289B7838D20086146&TransactionID=159599897&ExpressResponseCode=0&ExpressR esponseMessage=Approved&AVSResponseCode=Y&CVVResponseCode=M&ApprovalNum ber=289337&LastFour=0007&ValidationCode=BD46141F887E4653&CardLogo=Visa& ApprovedAmount=16.00&BillingAddress1=100&BillingZipcode=33606&Bin=44452 2&Entry=Manual&NetTranID=221860112425222&TranDT=2022-07-05%2011:24:25
Hosted Payments QuickStart Guide Rev C 13 August 2025
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:
Parameter
Description
TransactionSetup TransactionType values 1-20.
ReturnURL The web page that will receive the results from the transaction.
1 if the results are automatically returned to the ReturnURL, omit or set to 0 if
AutoReturn results are displayed from WorldPay and another button is required to be clicked
to execute the ReturnURL.
isTest 1 if running test transactions, omit or set to 0 if running live transactions.
Provide AccountID, AccountToken, AcceptorID, ApplicationID (test or live, Credentials
depending on isTest).
License Provide if live transactions.
ReferenceNumber Required unique value. Omit and a random value will be generated.
LaneNumber Required value. Does not have to be unique.
TerminalID Required value. Does not have to be unique.
Amount Required value. Amount to charge.
CVVRequired 1 if CVV must be provided, omit or 0 if CVV is not required to be provided.
BillingAddress1 If AVS street address checking is desired, enter value for BillingAddress1.
BillingZipCode If AVS ZIP code checking is desired, enter a value for BillingZipCode.
If running on mobile platform, setting Embedded=1 will optimize the credit card Embedded collection form for mobile viewing
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.
Hosted Payments QuickStart Guide Rev C 13 August 2025
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”, “ReferenceNumbe”: “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” }
Hosted Payments QuickStart Guide Rev C 13 August 2025
Documents / Resources
 |
ID TECH VP6300 Hosted Payments [pdf] User Guide VP6300 Hosted Payments, VP6300, Hosted Payments, Payments |