CustomerHosted
Description: Use this method to let KORT Payments perform collection of Customer Vault information on our secure servers. This page can be displayed as a standalone page, or be displayed in an iFrame. You can specify a style sheet (in parameter "CSSUrl") for a customized look-and-feel.
Resource Url: https://webservice.paymentxp.com/wh/EnterCustomer.aspx
Method: POST
Content-Type: application/x-www-form-urlencoded
Notes
- Parameters in bold are required in the request for example, BillingNameFirst
Request
| Parameter | Is Required | Data Type | Max Length | Description |
|---|---|---|---|---|
AccountName |
No | String | 250 | Your customer's name on account (First name + Last name). |
AccountNumber |
No | String | 17 | The full account number. If value has X's included, (for instance, if it's masked) then it will assume the previously saved account number You can use the Token value here instead. |
Address |
No | String | 50 | Address of the account holder |
BankAccountType |
No | String | 10 | Your customer's Bank Account Type: CK = Checking Account SA = Savings Account |
BankName |
No | String | 50 | Your customer's bank name. |
CardExpirationDate |
No | String | 4 | Month and Year of Card Expiration Date in MMYY format |
CardNumber |
No | String | 60 | The full card number. if value has X's included, (for instance, if it's masked) then it will assume the previously saved account number. You can use the Token value here instead. |
City |
No | String | 50 | City of the account holder |
Country |
No | String | 50 | Country of the account holder |
CSSUrl |
No | String | 255 | If specified, the publicly readable url will be referenced to override default css style rules. |
CustomerID |
Yes | String | 50 | Your customer's ID. |
CustomerName |
Yes | String | 50 | Your customer's name. |
Email |
No | String | 50 | Email address of the account holder |
Fax |
No | String | 25 | Fax number of the account holder |
FirstName |
No | String | 50 | First name of the account holder |
HideCustomerInfo |
No | String | 1 | Set to “1” to Hide the CustomerID and CustomerName field. Set to “0” to display. |
Inline |
No | String | 1 | Setting this to "0" will not render the form's header and footer. This is useful if you're rendering this form in an iFrame. Default is "1". |
LastName |
No | String | 50 | Last name of the account holder |
MerchantID |
Yes | Number | 5 | The identification that is assigned to the merchant. |
MerchantKey |
Yes | String | 100 | A unique identification that is assigned to the merchant id. Note: For merchants using Hosted Payment functionality, pass the ‘Hosted Payment Key’ token provided by KORT Payments for each merchant into the MerchantKey data field. |
Phone |
No | String | 25 | Phone number of the account holder |
PostBackMethod |
No | String | 255 | Value should be "get" or "post". (specify "get" if you are going to be posting back to a "non-ssl" secured page. |
PostBackUrl |
No | String | 255 | If specified, the publicly readable url where the response parameters will be posted. If left blank, save results will besent to our default response page. |
RequireCardInfo |
No | String | 1 | Set to “1” to require credit card number and expiration date to be entered. Set to “0” otherwise. |
ReturnUrl |
No | String | 255 | This url will be displayed in a link on the response page. |
RoutingNumber |
No | String | 9 | Your customer's bank's routing number |
SilentPostBackUrl |
No | String | 255 | On submit, the output will be posted to this url. |
State |
No | String | 25 | State of the account holder |
TransactionType |
Yes | String | 14 | CustomerHosted |
Zip |
No | String | 25 | Zipcode of the account holder |
Response
| Field Name | Description |
|---|---|
PostedDate |
The date and time the transaction was posted. |
StatusID |
The result of the transaction. Status 1 indicates an approved transaction. |
Message |
The message from the processor. |
Status |
Status description |
CardNumber |
Last 4 digits of the card number |
CustomerName |
The name of the account holder as it appears on the account |
BillingNameFirst |
The first name of the account holder. |
BillingNameLast |
The last name of the account holder. |
Address |
The billing address of the cardholder. Used to check for AVS identification. |
City |
The billing city of the cardholder. |
State |
The billing state of the cardholder. |
Zip |
The billing zip code of the cardholder. Used to check forAVS identification. |
Country |
The billing country of the cardholder. |
Phone |
The phone number of the cardholder. |
Fax |
The fax number of the cardholder. |
Email |
The e-mail address of the cardholder. |
BankName |
Your customer's bank name. |
AccountName |
Your customer's name on account (First name + Last name). |
RoutingNumber |
Routing number or ABA. |
AccountNumber |
The last 4 of the Account Number or DDA. |
CardExpirationDate |
Your customer's card expiration date. |
BankAccountType |
Your customer's Bank Account Type: CK = Checking Account SA = Savings Account |