Service Location:
https://<assigned domain>/ws/hostedpage.aspx?
Input Parameters:
These values must all be separated by the ‘&’ character and appended to the service location of the hosted page.
Example (to be used as a formatting reference only):
https://<assigned domain>/ws/hosted.aspx?Username=tUhbZ8%2bhVy2pvrHUvXA%3d%3d&Password=76%2fP0EP7La9Go6dn4OgLH9lI5zT0fykgUKAyTi3KbNlhGAf%2fLsNpimtPqqN9&MerchantKey=11111
O = Optional, R = Required, R* = Conditional
|
Parameter Name |
Opt/Req |
Description |
|
Username |
R |
The Username parameter generated in the security tab of the Hosted Page configuration utility |
|
Password |
R |
The Password parameter generated in the security tab of the Hosted Page configuration utiliity |
|
MerchantKey |
R |
This is the Gateway ID of the gateway account you are trying to connect to. This value is also referred to as the Vendor Key or RPNumber |
|
CustomerName |
O |
This is the card holder name value |
|
ShippingAddress1 |
O |
Identifies the first line of the card holder’s shipping address |
|
ShippingAddress2 |
O |
Identifies the second line of the card holder’s shipping address |
|
ShippingState |
O |
Identifies the State of the card holder’s shipping address |
|
ShippingCity |
O |
Identifies the City of the card holder’s shipping address |
|
ShippingZip |
O |
Identifies the Zip code of the card holder’s shipping address |
|
ShippingIsBilling |
O |
A Boolean field which allows the integrator to specify that the shipping address and billing address are equivalent. If this field is passed in and set to ‘True’, all billing address information passed to the hosted page will be ignored. |
|
BillingAddress1 |
O |
Identifies the first line of the card holder’s billing address |
|
BillingAddress2 |
O |
Identifies the second line of the card holder’s billing address |
|
BillingState |
O |
Identifies the State of the card holder’s billing address |
|
BillingCity |
O |
Identifies the City of the card holder’s billing address |
|
BillingZip |
O |
Identifies the Zip code of the card holder’s billing address |
|
Amount |
R* |
Amount of the transaction you are trying to run. This value is required if you are not allowing the customer to specify the amount |
|
InvNum |
O |
Invoice Number to be associated with the current transaction |
|
CustomerID |
O |
The Customer ID value to be associated with the current transaction |
|
TaxAmount |
O |
The Tax Amount to be associated with the current transaction |
|
ShippingAmount |
O |
The Shipping Amount to be associated with the current transaction |