Technology
Lateral Payment Solutions provide an online credit card/debit card processing solution for e-commerce businesses. We provide a highly sophisticated fraud screening process to reduce the risk posed to online merchants in the ‘card not present’ environment. We provide a 256 bit SSL interface for secure transmission of data over the internet. A secure reporting and administration system to provide real time information is also made available to the merchant. This document serves to explain the technical integration requirements and procedures. It is of a technical nature and should be read as such.
| Field | Description | Mandatory | Data Type |
|---|---|---|---|
| merchant_User_Id | Merchant’s user id provided by LPS | Y | Mixed |
| merchantpwd | Merchant’s PWD provided by LPS | Y | Mixed |
| merchant_ipaddress | Static IP address of the Merchant server | Y | As provided by merchant |
| customer_firstname | First name of the customer | Y | Mixed |
| customer_lastname | Last name of the customer | Y | Mixed |
| customer_phone | Telephone number of the customer | Y | Mixed |
| customer_email | Email address of the customer | Y | Mixed |
| customer_ipaddress | IP address of the customer | Y | Mixed |
| bill_firstname | First name of the card holder | Y | Mixed |
| bill_lastname | Last name of the card holder | Y | Mixed |
| bill_address1 | First line of street address for billing the CC | Y | Mixed |
| bill_address2 | Second line of street address for billing the CC Optional | Mixed | |
| bill_city | City for the billing the credit card | Y | Mixed |
| bill_country | Country for the billing the credit card | See LPS | |
| bill_state | State for the billing the credit card Optional See LPS | Standard Codes | |
| bill_zip | Postal code for the billing the credit card | Y | Mixed |
| dateregistered | Date customer setup an account with your site Optional | Mixed | |
| customer_cc_expmo | Expiration month(mm) of the credit card | Y | Mixed |
| customer_cc_expyr | Expiration year(yyyy) of the credit card | Y | Mixed |
| customer_cc_number | Credit card/Debit card number of the customer | Y | numeric |
| customer_dc_issue | Debit card issue number Y (for debit cards only) | numeric | |
| customer_dc_startmo | Debit card start month or valid from month(mm) | for debit cards only | Mixed |
| customer_dc_startyr | Debit card start year or valid from year (yyyy) | for debit cards only | Mixed |
| customer_cc_type | Credit Card type of the customer either VISA,MAST, SWITCH, SOLO, DELTA, AMEX, MAESTRO (Case Sensitive, upper case only) | Y | Mixed |
| customer_cc_cvc | CVC number of the bank of customer card | Y | numeric |
| customer_bank_name | Name of issuing bank of customer card | Y | |
| ship_to_address1 | First line of the street address to ship the product | Y | Mixed |
| ship_to_address2 | Second line of the street address to ship the product | Y | Mixed |
| ship_to_city | City to which the ship the product | Y | Mixed |
| ship_to_country | Country to which the ship the product | Y | Mixed |
| ship_to_phone | Telephone number of shipping destination | Y | Mixed |
| ship_to_state | State or province to which the ship the product | Y | Mixed |
| ship_to_zip | Postal code to which the ship the product | Y | Mixed |
| ship_to_method | Shipping method | Y | Mixed |
| merchant_ref_number | Merchant generated reference number | Y | Mixed |
| currencydesc=”XXX” | XXX is the currency code you are transacting in i.e., USD, GBP, EUR | Y | See LPS Standard Codes |
| amount | 2 decimal places only | Y | Numeric |
| Field | Description | Data Type | Len |
|---|---|---|---|
| ResponseType | Transaction response type | int | 4 |
| LPS_transaction_id | Unique Identifier for the transaction generated by LPS | int | 8 |
| Merchant_ref_number | Merchant reference number generated for the order | varchar | 50 |
| Lpsid | Login id of merchant site for authentication | varchar | 50 |
| Lpspwd | Password for LPS on Merchant site | varchar | 50 |
| Fraudscreening_status | Fraud screening response code from LPS | int | 4 |
| Bank status | Status of the transaction at the bank | int | 4 |
| Amount | Transaction | amount | 2 decimal places |
| Currency | Transaction currency as per ISO code | varchar | 4 |
| Bank_transaction_no | Unique Bank ID | varchar | 50 |
| Bank_authorisation_no | Bank authorization number, save for your records | varchar | 50 |
| Bank_date | Date of bank transaction | varchar | 50 |
| Bank_time | Time of bank transaction | varchar | 50 |
| Bank_original_code | Original Bank Status code | varchar | 255 |
Note:
• The entire Schedule 2B is always returned regardless of the transaction status.
• The variables highlighted above in blue are always returned with values regardless of the
ResponseType.
• With a ResponseType=0 (fraudscreening status) then the variables in green will be blank. With a
ResponseType=1 then all variables will be returned with appropriate values.
When the customer is redirected to a URL on LPS Gateway after 3D SECURE authentication, it will match the transaction Id passed with the existing pending transaction. The status of the transaction will be updated to “3D SECURE Response Returned” and the 3D SECURE response will then be transferred back to a merchant’s URL which will return the customer back to the merchant site along with the details given in Table 2E.
The merchant should extract the 3D SECURE response and update the status of the transaction as 3D SECURE Response received. Note at this stage neither LPS nor the merchant know if the 3D SECURE authentication is successful. They will then open synchronous connection back to LPS payment gateway with the transaction details as shown in Table 2F.
| Field | Description | Required/ Optional | Data Type | Len |
|---|---|---|---|---|
| merchant_User_Id | Merchant’s user id provided by LPS | Required | varchar | 50 |
| merchantpwd | Merchant’s PWD provided by LPS | Required | varchar | 50 |
| merchant_ipaddress | Static IP address of the Merchant server | Required , As provided by merchant | ||
| customer_firstname | First name of the customer | Required | varchar | 50 |
| customer_lastname | Last name of the customer | Required | varchar | 50 |
| customer_phone | Telephone number of the customer Required | varchar | 50 | |
| customer_email | Email address of the customer | Required | varchar | 50 |
| customer_ipaddress | IP address of the customer | Required | varchar | 50 |
| bill_firstname | First name of the card holder | Required | varchar | 50 |
| bill_lastname | Last name of the card holder | Required | varchar | 50 |
| bill_address1 | First line of street address for billing the CC | Required | varchar | 100 |
| bill_address2 | Second line of street address for billing the CC | Optional | varchar | 100 |
| bill_city | City for the billing the credit card | Required | varchar | 50 |
| bill_country | Country for the billing the credit card | Required | See LPS Standard Codes | |
| bill_state | State for the billing the credit card | Optional | See LPS Standard Codes | |
| bill_zip | Postal code for the billing the credit card | Required | varchar | 50 |
| dateregistered | Date customer setup an account with your site | Optional | varchar | 50 |
| customer_cc_expmo | Expiration month(mm) of the credit card | Required | varchar | |
| customer_cc_expyr | Expiration year(yyyy) of the credit card | Required | varchar | 50 |
| customer_cc_number | Credit card/Debit card number of the customer | Required | numeric | 50 |
| customer_dc_issue | Debit card issue number Required (for debit cards only) | numeric | 2 | |
| customer_dc_startmo | Debit card start month or valid from month (mm) Required (for debit cards only) | varchar | 50 | |
| customer_dc_startyr | Debit card start year or valid from year (yyyy) Required (for debit cards only) | varchar | 50 | |
| customer_cc_type | Credit Card type of the customer either VISA, MAST, SWITCH, SOLO,DELTA, AMEX, MAESTRO (Case Sensitive, upper case only) | Required | varchar | 10 |
| customer_cc_cvc | CVC number of the bank of customer card Required | numeric | 3 | |
| customer_bank_name | Name of issuing bank of customer card | Optional | ||
| ship_to_address1 | First line of the street address to ship the product | Optional | varchar | 50 |
| ship_to_address2 | Second line of the street address to ship the product | Optional | varchar | 50 |
| ship_to_city | City to which the ship the product | Optional | varchar | 50 |
| ship_to_country | Country to which the ship the product | Optional | varchar | 50 |
| ship_to_phone | Telephone number of shipping destination | Optional | varchar | 50 |
| ship_to_state | State or province to which the ship the product | Optional | varchar | 50 |
| ship_to_zip | Postal code to which the ship the product | Optional | varchar | 50 |
| ship_to_method | Shipping method | Optional | varchar | 50 |
| merchant_ref_number | Merchant generated reference number | Required | varchar | 50 |
| currencydesc=”XXX” | XXX is the currency code you are transacting in i.e., USD, GBP, EUR | Required | See LPS Standard Codes | |
| amount Purchase | Amount – 2 decimal places only | Required | 2 decimal places | |
| 3dSecureCheck | Flag to indicate whether 3d secure code check to be performed. Valid values Y,N. Default : N | Optional | varchar | 1 |
| FIELDS | DESCRIPTIONS | DATA TYPE | LENGTH |
|---|---|---|---|
| ResponseType | Transaction response type -Point A | int | 4 |
| LPS_transaction_id | Unique Identifier for the transaction generated by LPS | int | 4 |
| Merchant_ref_number | Merchant reference number generated for the order | varchar | 50 |
| Lpsid | LPS Response Authentication User Id | varchar | 50 |
| Lpspwd | LPS Response Authentication User Password | varchar | 50 |
| Fraudscreening_status | Fraud screening response code from LPS – Point B | int | 4 |
| Bank_status | Status of the transaction at the bank - Point C | int | 4 |
| Amount | Transaction amount | 2 decimal places | |
| Currency | Transaction currency as per ISO code | varchar | 4 |
| Bank_transaction_no | Unique Bank ID | varchar | 50 |
| Bank_authorisation_no | Bank authorization number, save for your records varchar 50 | ||
| Bank_date | Date of bank transaction | varchar | 50 |
| Bank_time | Time of bank transaction | varchar | 50 |
| Bank_original_code | Original Bank Status code | varchar | 255 |
| AVS_Result | Customer Address verification result for the address line1 value posted by merchant Values: Empty or 2: Not verified / Not checked; 1: Failed;0: Successful. | Int | 4 |
| CVN_Result | Result of CVC entered by customer Values:Empty or 2: Not verified / Not checked; 1: Failed;0: Successful. | Int | 4 |
| CrdStrg_Token*** | Unique card token generated for the card posted | varchar | 100 |
Note:
• The entire Schedule 2B is always returned regardless of the transaction status.
• The variables highlighted above in blue are always returned with values regardless of the ResponseType.
• With a ResponseType=0 (fraudscreening status) then the variables in green will be blank. With a ResponseType=1 then all variables will be returned with appropriate values.
• ***CrdStrg_Token: Will be returned only if SCSScheck was set to Y on request post (or) the token itself was posted on request along with SCSScheck set to D.
LPS Hosted Payment System (HPS) is a simple integration method suitable for all e-commerce merchants. It allows real-time transaction processing and at the same time can remove the problems involved in collecting and storing of cardholder details on merchant systems.
The HPS is fully secure and linked to the LPS enterprise payment gateway which provides sophisticated fraud and risk assessment in addition to authorising the transaction. The HPS uses HTML redirect messages to pass information between merchant e-commerce site and LPS. This method does not involve installation of any files at merchant site and hence is very simple to implement. We provide a 256 bit SSL interface for secure transmission of data over the internet.
A secure reporting and administration system to provide real time information is also made available to the merchant. This document serves to explain the technical integration requirements and procedures. It is of a technical nature and should be read as such. HPS
This integration method uses HTML forms to pass information to LPS payment gateway for payment processing. Merchants should create a purchase order form which describes the details of goods or service purchased by the customer.
- When a shopper is ready to pay for their goods, the merchants website should submit the order details to our hosted payment page.
- The shopper will then be taken to the LPS payment page to enter their payment details, such as credit/debit card details.
- If the shopper has chosen to pay by credit/debit card: • HPS system sends a request to LPS enterprise payment gateway which forwards the shopper’s details to the bank, where a card authorisation is attempted • the bank returns an authorised or declined response to LPS
- HPS then displays the result to the shopper and also sends them a confirmation email.
- The transaction status is then sent to merchant. If the merchant had opted for synchronous postback response then HPS will call the merchant postback URL and post the response fields. The customer is then taken back to merchant site along with the response fields in another HTML redirect post session.
- OVERVIEW Integrating with LPS Hosted Payment System is a very simple process. The points below describe the process of setting up an integration using a sample HTML form.
- ORDER DETAILS TO LPS HPS Order details submission from merchant to LPS HPS is simply a HTML form with a number of post fields. It should contain a list of mandatory fields as specified in Appendix A “Authorisation Post Fields & Response Fields”. It can also contain a range of optional fields. The merchant system should “POST” this form to the LPS HPS URL when customer has selected to proceed with making payment on merchant site.
<form method="post" action="HPS_payment.aspx">
<!--Authentication details-->
<input type="hidden" name="Merchant_User_Id" value="" />
<input type="hidden" name="merchantpwd" value="" />
<!--Customer Details-->
<input type="hidden" name="customer_firstname" value="" />
<input type="hidden" name="customer_lastname" value="" />
<input type="hidden" name="customer_phone" value="" />
<input type="hidden" name="customer_email" value=""/>
<input type="hidden" name="customer_ipaddress" value="" />
<!--Billing details-->
<input type="hidden" name="bill_firstname" value=""/>
<input type="hidden" name="bill_lastname" value=""/>
<input type="hidden" name="bill_address1" value="" />
<input type="hidden" name="bill_address2" value="" />
<input type="hidden" name="bill_city" value="" />
<input type="hidden" name="bill_country" value="" />
<input type="hidden" name="bill_state" value="" />
<input type="hidden" name="bill_zip" value="" />
<!--Delivery details-->
<input type="hidden" name="ship_to_address1" value="" />
<input type="hidden" name="ship_to_address2" value="" />
<input type="hidden" name="ship_to_city" value="" />
<input type="hidden" name="ship_to_country" value="" />
<input type="hidden" name="ship_to_phone" value="" />
<input type="hidden" name="ship_to_state" value="" />
<input type="hidden" name="ship_to_zip" value="" />
<input type="hidden" name="ship_to_method" value="" />
<input type="hidden" name="merchant_ref_number" value="" />
<!--Purchase details-->
<input type="hidden" name="Purchase_summary" Value="" />
<input type="hidden" name="currencydesc" Value="" />
<input type="hidden" name="amount" Value= "" />
<!--Security details-->
<input type="hidden" name="transactionkey" Value="" />
</form>| Field | Description | Required/ Optional | Data Type | Length |
|---|---|---|---|---|
| merchant_User_Id | Merchant’s user id provided by LPS | Required | varchar | 50 |
| merchantpwd | Merchant’s PWD provided by LPS | Required | varchar | 50 |
| customer_firstname | First name of the customer | Required | varchar | 50 |
| customer_lastname | Last name of the customer | Required | varchar | 50 |
| customer_phone | Telephone number of the customer | Required | varchar | 50 |
| customer_email | Email address of the customer | Required | varchar | 50 |
| customer_ipaddress | IP address of the customer | Required | varchar | 50 |
| bill_firstname | First name of the card holder | Required | varchar | 50 |
| bill_lastname | Last name of the card holder | Required | varchar | 50 |
| bill_address1 | Bill address line1 | Required | varchar | 100 |
| bill_address2 | Bill address line2 | Optional | varchar | 100 |
| bill_city | Bill_city | Required | varchar | 50 |
| bill_country | Bill_country | Required | See LPS Standard Codes | |
| bill_country | Bill_country | Required | See LPS Standard Codes | |
| bill_state | Bill state | Optional | varchar | 50 |
| bill_zip | Postal code for the billing the credit card | Required | varchar | 50 |
| ship_to_address1 | Delivery address line1 | Optional | varchar | 50 |
| ship_to_address2 | Delivery address line2 | Optional | varchar | 50 |
| ship_to_city | Delivery city | Optional | varchar | 50 |
| ship_to_country | Delivery country | Optional | varchar | 50 |
| ship_to_phone | Telephone number of shipping destination | Optional | varchar | 50 |
| ship_to_state | State or province to which the ship the product | Optional | varchar | 50 |
| ship_to_zip | Postal code to which the ship the product | Optional | varchar | 50 |
| ship_to_method | Shipping method | Optional | varchar | 50 |
| merchant_ref_number | Purchase order number | Required | varchar | 50 |
| Purchase_summary | Summary details of the purchase details | Required | varchar | 1000 |
| currencydesc | Purchase Currency in 3 digit ISO format. | Required | See LPS Standard Codes | |
| amount | Purchase Amount – 2 decimal places only | Required | Numeric |
| Field | Description | Data Type |
|---|---|---|
| Merchant_User_Id | Merchant’s user id provided by LPS | varchar |
| Merchant_ref_number | Purchase order number | varchar |
| Lpsid | Login id of merchant site for authentication | varchar |
| Lpspwd | Password for LPS on Merchant site. | varchar |
| Transactionid | Unique Identifier for the transaction generated by LPS | Integer |
| Requestid | Unique Identifier for the transaction generated by HPS | Integer |
| bill_firstname | First name of the card holder | varchar |
| bill_lastname | Last name of the card holder | varchar |
| Purchase_summary | Summary details of the purchase details | varchar |
| currencydesc | CurrencyCode in ISO 3 digit format | See LPS Standard Codes |
| amount | Purchase Amount – 2 decimal places only | 2 decimal places |
| CardBin | First six digit of the customer card | integer |
| CardLast4 | Last four digit of the customer card | integer |
| CardType | Card scheme of customer card | varchar |
| CardHolderName | Card holder name as entered on payment page | varchar |
| CardIssuingCountry | Card issuer country (2 digit ISO codes) | See LPS Standard Codes |
| CardExpiry | Card expiry as selected on payment page in the form of “MMYYYY” i.e., 012016 | varchar |
| merchant_ipaddress | Posted Merchant server IP address | varchar |
| TransDateTime | Date and time of transaction processed | DateTime |
| CVN_Result | CVN result code | Integer |
| AVS_Result | AVS result code | Integer |
| Status | Transaction status | Refer to LPS Responsecodes |
| CardToken | Unique card token generated for the card processed | varchar |
| Bank_Code | Bank reason code | Integer |
| Bank_Message | Bank reason message | varchar |
| Code | Description | Reason |
|---|---|---|
| 00 | Transaction Approved | |
| 05 | Transaction Rejected | Bank Declined |
| 90 | Communication Failure, Status Unknown | Contact LPS |
| 92 | Customer payment cancellation | Customer cancelled before payment |
| 1001 | Authentication failed for Merchant | Wrong id, password or IP supplied |
| 1002 | Merchant account inactive | Merchant account inactive |
| 1003 | Transaction amount exceeds the Per Transaction Limit | Purchase amount is above a specified level |
| 1004 | Customer has exceeded allowed transactions number for 24 hours | Velocity control on purchases per day |
| 1005 | Code not in use | |
| 1006 | Invalid credit card number | Incorrect digit length for card type |
| 1007 | Invalid credit card expiry details | |
| 1008 | Luhn’s modulus check failed | Card number invalid |
| 1009 | Code not in use | |
| 1010 | Failed Country lookup | Bill country is not accepted by the bank |
| 1011 | Failed IP lookup | Customer IP is blocked |
| 1012 | Failed BIN lookup | Customer card BIN is blocked |
| 1013 | Bank rejection limit exceeded | |
| 1014 | Customer blocked | Customer details are blocked |
| 1015 | Minimum purchase check | Purchase amount is below a specified level |
| 1016 | Failed IP check.*** | Customer IP not in allowed list of IP’s |
| 1022 | Account not enabled for HPS | Merchant account not enabled for HPS |
| 9000 | Unexpected error | Incorrect data types, unknown error |
| 9001 | Missing required field | A transactionid of –1 will also be returned |
| 9002 | Code not in use | Code not in use |
| 9003 | Currency Block*** | Currency NOT enabled. |
NB. Any response codes that are denoted by *** may not be activated for you account(s).
Merchants can post a request to the LPS gateway to be void/reverse an authorisation. When a request is submitted, the gateway performs a series of checks and then directly forwards a void request to the bank for transaction reversal. A response is sent back to the merchant in real time to acknowledge the request and confirm if its been accepted or declined. The status of the request can also be viewed by logging onto the merchants reporting system on the LPS website.
Merchants can post a request to the LPS gateway to refund a settled transaction. When a request is submitted, the gateway performs a series of checks and then responds back to the merchant. Refunds are checked by LPS Admin staff before they are sent to the bank. Depending on the banks rules, this API can be used to perform partial refunds as well. The status of the request can be viewed by logging onto the merchants reporting system on the LPS website.
Merchants can post a request to the LPS gateway to make a payment to a customers card number via the recredits system. When a request is submitted, the gateway performs a series of checks and responds back to the merchant. The submitted transactions are checked by LPS Admin staff before they are sent to the bank. The status of request can be viewed by logging onto the merchants reporting system on the LPS website.
Merchants can post a request to the LPS gateway to make a payment to a customers bank account via the LPS Wires system. When a request is submitted, the gateway performs a series of checks and responds back to the merchant. The submitted request is sent into the Banking network. The status of request can be viewed by logging onto the merchants reporting system on the LPS website. All requests are sent to LPS in the form of a HTTP synchronous POST over SSL. The LPS system then validates each individual request and responds on the same HTTP connection. This allows the merchant to incorporate the system into their backend process.
Merchants can post a request to the LPS gateway to make a payment to a customers sort code and account number or credit card number via the BAC’s system. When a request is submitted, the gateway performs a series of checks and then responds back to the merchant. The submitted BAC’s transactions are checked by LPS Admin staff before they are sent to the BAC’s network. The status of request can be viewed by logging onto the merchants reporting system on the LPS website.
Merchants can post a request to the LPS gateway to make a payment to a customers sort code and account number via the Faster Payments system. When a request is submitted, the gateway performs a series of checks and responds back to the merchant. The submitted Faster Payment are sent into the BAC’s network usually within a hour depending on the clients criteria. The status of request can be viewed by logging onto the merchants reporting system on the LPS website.
LPS Authorisation API system is also linked with “Secure Card Storage Services (SCSS)” system which will help merchants to comply with PCI DSS audit requirements by removing the necessity to store card details in their system. SCSS system reduces the overhead of storing, managing and transmitting credit card details and card holder data.
LPS standard integration post fields provides an option to flag a transaction to be part of SCSS and it automatically stores the card details and a corresponding token is returned back on the response. In addition to storing the card details, SCSS system also keeps references of billing details. Hence card details and billing details need not be posted when sending a transactions request for authorisation using a previously generated card store token. SCSS system will automatically extract the card details and its corresponding billing details and will use it for authorisation request.
In the event the billing details or card details needs to be updated, then merchants can make use of manage SCSS subsystem API to update or delete the card details.
The way the system works is as follows:
a. Merchants send normal authorisation request with SCSS flag set to Y.
b. A unique identifier is generated and returned along with the authorisation response.
c. The unique identifier acts as the reference for all subsequent transactions.
d. The identifier also references complete billing details of the card holder. Hence apart from the card details, billing details also will not be necessary when posting the identifier.
This phase is linked into the main authorisation system. This phase consists of the generation of unique identifier for the card holder data. The unique identifier is linked to the merchant account issued by LPS and if same identifier will be returned if the card details has been previously posted by the client and an identifier generated previously.
This phase consists of an independent API which will enable merchants to be in control of their secure card data. In the event the card details need updating, for example if the expire dates have changed due to card renewal or the customer’s address details have changed. The merchants can send the token as well the new details which will be automatically updated into the SCSS system. All the usual process of validating the credentials will be necessary before the details can be updated.
In the event that customer details are to be removed due to various reasons such as customer has closed their account or audit retention policy or customer deemed fraudulent etc, merchants can send the “Token Delete” request and the card details will be completely removed and cannot be used further.
| Field | Description | Required/ Optional | Data Type | Len |
|---|---|---|---|---|
| merchant_User_Id | Merchant’s user id provided by LPS | Required | varchar | 50 |
| merchantpwd | Merchant’s PWD provided by LPS | Required | varchar | 50 |
| merchant_ipaddress | Static IP address of the Merchant server | Required | As provided by merchant | |
| customer_firstname | First name of the customer | Required | varchar | 50 |
| customer_lastname | Last name of the customer | Required | varchar | 50 |
| customer_phone | Telephone number of the customer | Required | varchar | 50 |
| customer_email | Email address of the customer | Required | varchar | 50 |
| customer_ipaddress | IP address of the customer | Required | varchar | 50 |
| bill_firstname | First name of the card holder | Required | varchar | 50 |
| bill_lastname | Last name of the card holder | Required | varchar | 50 |
| bill_address1 | First line of street address for billing the CC | Required | varchar | 100 |
| bill_address2 | Second line of street address for billing the CC | Optional | varchar | 100 |
| bill_city | City for the billing the credit card | Required | varchar | 50 |
| bill_country | Country for the billing the credit card | Required | See LPS Standard Codes | |
| bill_state | State for the billing the credit card | Optional | See LPS Standard Codes | |
| bill_zip | Postal code for the billing the credit card | Required | varchar | 50 |
| dateregistered | Date customer setup an account with your site | Optional | varchar | 50 |
| customer_cc_expmo | Expiration month(mm) of the credit card | Required | varchar | 50 |
| customer_cc_expyr | Expiration year(yyyy) of the credit card | Required | varchar | 50 |
| customer_cc_number | Credit card/Debit card number of the customer | Required | numeric | 50 |
| customer_dc_issue | Debit card issue number | Required (for debit cards only) | numeric | 2 |
| customer_dc_startmo | Debit card start month or valid from month (mm) | Required (for debit cards only) | varchar | 50 |
| customer_dc_startyr | Debit card start year or valid from year (yyyy) | Required (for debit cards only) | varchar | 50 |
| customer_cc_type | Credit Card type of the customer either VISA, MAST, SWITCH, SOLO,DELTA, AMEX, MAESTRO (Case Sensitive, upper case only) | Required | varchar | 10 |
| customer_cc_cvc | CVC number of the bank of customer card | Required | numeric | 3 |
| customer_bank_name | Name of issuing bank of customer card | Optional | ||
| ship_to_address1 | First line of the street address to ship the product | Optional | varchar | 50 |
| ship_to_address2 | Second line of the street address to ship the product | Optional | varchar | 50 |
| ship_to_city | City to which the ship the product | Optional | varchar | 50 |
| ship_to_country | Country to which the ship the product | Optional | varchar | 50 |
| ship_to_phone | Telephone number of shipping destination | Optional | varchar | 50 |
| ship_to_state | State or province to which the ship the product | Optional | varchar | 50 |
| ship_to_zip | Postal code to which the ship the product | Optional | varchar | 50 |
| ship_to_method | Shipping method | Optional | varchar | 50 |
| merchant_ref_number | Merchant generated reference number | Required | varchar | 50 |
| currencydesc=”XXX” | XXX is the currency code you are transacting in i.e., USD, GBP, EUR | Required | See LPS Standard Codes | |
| amount | Purchase Amount – 2 decimal places only | Required | 2 decimal places | |
| 3dSecureCheck | Flag to indicate whether 3d secure code check to be performed. Valid values Y,N. Default : N | Optional | varchar | 1 |
| scsscheck | Flag to indicate if SCSS is required. Values: Y, N, D Y: Yes; N: No; [default if not sent] D: Done, token posted with the request | Conditional*** (Only if SCSS options are required). ***If set to Y or N, then CrdStrg_Token field will be ignored even if sent | varchar | 1 |
This response will be returned back to the merchant if the customer is NOT enrolled for 3D SECURE checks or after passing the 3D SECURE authentication request to LPS payment gateway. The ResponseType will either be 0 or 1. This response indicates the fraud screening or bank response.
| Field | Description | Data Type | Length |
|---|---|---|---|
| ResponseType | Transaction response type -Point A | int | 4 |
| LPS_transaction_id | Unique Identifier for the transaction generated by LPS | int | 4 |
| Merchant_ref_number | Merchant reference number generated for the order | varchar | 50 |
| Lpsid | LPS Response Authentication User Id | varchar | 50 |
| Lpspwd | LPS Response Authentication User Password | varchar | 50 |
| Fraudscreening_status | Fraud screening response code from LPS – Point B | int | 4 |
| Bank_status | Status of the transaction at the bank - Point C | int | 4 |
| Amount | Transaction amount | 2 decimal places | |
| Currency | Transaction currency as per ISO code | varchar | 4 |
| Bank_transaction_no | Unique Bank ID | varchar | 50 |
| Bank_authorisation_no | Bank authorization number, save for your records | varchar | 50 |
| Bank_date | Date of bank transaction | varchar | 50 |
| Bank_time | Time of bank transaction | varchar | 50 |
| Bank_original_code | Original Bank Status code | varchar | 255 |
| AVS_Result | Customer Address verification result for the address line1 value posted by merchant Values: Empty or 2: Not verified / Not checked; 1: Failed;0: Successful. | Int | 4 |
| CVN_Result | Result of CVC entered by customer Values: Empty or 2: Not verified / Not checked; 1: Failed; 0: Successful. | int | 4 |
| CrdStrg_Token*** | Unique card token generated for the card posted | varchar | 100 |
Note:
• The entire Schedule 2B is always returned regardless of the transaction status.
• The variables highlighted above in blue are always returned with values regardless of the ResponseType.
• With a ResponseType=0 (fraudscreening status) then the variables in green will be blank. With a ResponseType=1 then all variables will be returned with appropriate values.
• ***CrdStrg_Token: Will be returned only if SCSScheck was set to Y on request post (or) the token itself was posted on request along with SCSScheck set to D.
| Field | Description | Data Type | Length |
|---|---|---|---|
| ResponseType | Transaction response type - Point A | int | 4 |
| LPS_transaction_id | Unique Identifier for the transaction generated by LPS | int | 4 |
| Merchant_ref_number | Merchant reference number generated for the order | varchar | 50 |
| Lpsid | LPS Response Authentication User Id | varchar | 50 |
| Lpspwd | LPS Response Authentication User Password | varchar | 50 |
| VBV_URL | Fraud screening response code from LPS Customer’s | Issuing Bank 3D SECURE Authentication URL | varchar |
| PAReq | 3D SECURE Provider Payment Authentication Request | Text |
The entire Schedule 2C is always returned if the customer is enrolled for 3D SECURE. The merchant must check for a valid value in VBV_URL before redirecting the customer along with PAReq and other hidden field details as given in Schedule 2D.
| Field Name | Type | Size | Descrip | Required |
|---|---|---|---|---|
| Merchant_User_Id | Alpha | 50 | LPS Merchant account Id | M |
| MerchantPwd | Alphanumeric | 50 | LPS Merchant account password | M |
| TransactionType | Alphanumeric | 2 | Transaction Type, “BNLKP” for bin lookup | M |
| Merchant_Ref_Number | Alphanumeric | 2 | Specific order number submitted by the Merchant for tracking purposes Example “10098987” | M |
| BinNumber | Numeric | 6 | Card Bin to lookup details | M |
| Form Field | Description | Addtional Notes |
|---|---|---|
| ResponseType | Type of Response from LPS. It will be 5 if the response is for bin lookup risk management services | ResponseType = 5 for bin lookup |
| RequestId | Request Id generated for the risk request | |
| MerchantRefNumber | Order Number submitted by the merchant | |
| TransactionType | Transaction type processed | “BNLKP” for bin lookup request |
| CardBin | Card Bin Number | First 6 digit of card number |
| CardName | Name of the Card For e.g. Visa Credit, Visa Debit etc. | Returned only if status = 0 |
| CardType | Card type. e.g., VI, MC | Returned only if status = 0 |
| CountryCode | Country code of the Card Issuer | Returned only if status = 0 |
| Status | Status of the lookup request | Please see the table below |
| Code | Description | Reason |
|---|---|---|
| 0 | Lookup successful | Card bin details returned in response |
| 1 | Lookup Failed | Unable to locate card bin details |
| 1001 | Authentication failed for Merchant | Wrong id, password supplied |
| 1002 | Merchant account inactive | Merchant account inactive |
| 1022 | Account not enabled for card lookup | Merchant account not enabled |
| 6009 | Number of Binlookup attempts exceeded | Number of Binlookup attempts exceeded |
| 9000 | Unexpected error | Incorrect data types, unknown error |
| 9001 | Missing required field | RequestId of –1 will also be returned |
ResponseType=5&RequestId=1026&MerchantRefNumber=lpsReq123&TransactionType=BNLKP&CardBin=545460&CardN
ame=MCI+CREDIT&CardType=MC&CountryCode=US&Status=0