CreditCardHosted
Description: Use this method to let KORT Payments perform collection of sensitive credit card information on our secure servers.
Resource Url: https://webservice.paymentxp.com/wh/EnterPayment.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 |
|---|---|---|---|---|
BillingAddress |
No | String | 50 | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity |
No | String | 50 | The billing city of the cardholder. |
BillingCountry |
No | String | 50 | The billing country of the cardholder. |
BillingFullName |
No | String | 50 | The name of the cardholder as it appears on the card. |
BillingNameFirst |
Yes | String | 50 | The first name of the cardholder. Note: Required if BillingFullName not present |
BillingNameLast |
Yes | String | 50 | The last name of the cardholder. Note: Required if BillingFullName not present |
BillingState |
No | String | 25 | The billing state of the cardholder. |
BillingZipCode |
No | String | 10 | The billing zip code of the cardholder. Used to check for AVS identification. |
ClerkID |
No | String | 15 | The cashier/clerk who initiated the transaction. |
ClientIPAddress |
No | String | 25 | The IP address of the client device. |
CustomerID |
No | String | 255 | Use existing customer record to populate billing information. |
Custominfo1 (1-20) |
No | String | 255 | For merchant use. |
EmailAddress |
No | String | 50 | The e-mail address of the cardholder. |
EnableSwiper |
No | String | 1 | Set to 1 to enable card swipe capabilities. Set to 0 otherwise. Defaults to 0. |
MerchantID |
Yes | Number | 9 | 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. |
PaymentMemo |
No | String | 50 | Additional payment memo. |
PhoneNumber |
No | String | 10 | The phone number of the cardholder. |
PostBackURL |
No | String | 255 | URL to redirect customer after sale has been posted. If left blank, customer will be redirected to our default results page. |
ProductDescription |
No | String | 255 | Use to identify product name. |
ReferenceNumber |
No | String | 50 | The merchant/customer transaction identifier. |
ReturnURL |
No | String | 255 | URL provider as a link on the results page to send customerback to merchant website. |
ShippingAddress1 |
No | String | 50 | The shipping address for the product(s) purchased in the transaction. |
ShippingAddress2 |
No | String | 50 | Additional shipping address information for the product(s)purchased in the transaction. |
ShippingCity |
No | String | 50 | The shipping city for the product(s) purchased in the transaction. |
ShippingCountry |
No | String | 50 | The shipping country for the product(s) purchased in the transaction. |
ShippingState |
No | String | 25 | The shipping state for the product(s) purchased in the transaction. |
ShippingZipCode |
No | String | 10 | The shipping zip code for the product(s) purchased in the transaction. |
SilentPostBackURL |
No | String | 255 | Status post back URL via HTTP POST. |
Token |
No | String | 40 | KORT Payments Token. If you supply a token, you don’t need to supply the MerchantKey, and TransactionAmount |
TransactionAmount |
Yes | Number | 9 | Identifies the transaction’s total amount in US dollars. Note: Not required if you’re using a KORT Payments Token |
TransactionType |
Yes | String | 16 | CreditCardHosted, CreditCardCharge: Performs a Charge CreditCardAuthorization: Performs an Authorization |
Response
| Field Name | Description |
|---|---|
PostedDate |
The date and time the transaction was posted. |
StatusID |
The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID |
The number that identifies the transaction in the KORT Payments system. |
ReferenceNumber |
The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount |
Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode |
Authorization code from the issuing bank. |
ResponseCode |
The approval or decline code from the processor. |
ResponseMessage |
The approval or decline message from the processor. |
CVV2ResponseCode |
The CVV2 response code. |
CVV2ResponseMessage |
The CVV2 response message. |
AVSResponseCode |
The AVS response code. |
AVSResponseMessage |
The AVS response message. |
URLPostback |
URL to redirect customer after sale has been posted |
CardNumber |
Identifies the last 4 cardholder’s account number. |
CustomerName |
The name of the cardholder as it appears on the card. |
BillingNameFirst |
The first name of the cardholder. |
BillingNameLast |
The last name of the cardholder. |
BillingAddress |
The billing address of the cardholder. Used to check for AVS identification. |
BillingCity |
The billing city of the cardholder. |
BillingState |
The billing state of the cardholder. |
BillingZip |
The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry |
The billing country of the cardholder. |
BillingPhone |
The phone number of the cardholder. |
BillingFax |
The fax number of the cardholder |
BillingEmail |
The e-mail address of the cardholder. |
CustomerID |
An existing customer record. |
ProductDesc |
Use to identify product name. |
Action |
The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 |
The shipping address of the cardholder. |
ShippingAddress2 |
The shipping address of the cardholder. |
ShippingCity |
The shipping city of the cardholder. |
ShippingState |
The shipping state of the cardholder. |
ShippingZipCode |
The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry |
The shipping country of the cardholder. |
Custominfo1 (1-20) |
For merchant use. |
TransTypeID |
Identifies the type of transaction that was processed. View appendix F. |
SettleDate |
The date and time the transaction was settled. |
VoidDate |
The date and time the transaction was voided. |
RefundDate |
The date and time the transaction was refunded. |
TransactionStatusID |
Identifies the status of the transaction that was processed. View appendix G. |
