Kumar A. ADempiere 3.6 Cookbook
Подождите немного. Документ загружается.
PayPal Integration
248
}
return m_ok;
}
public boolean isProcessedOK ()
{
return m_ok;
}
}
2. Build the project and launch the desktop version of ADempiere.
3. Log in as GardenAdmin/GardenAdmin with the GardenWorld Admin role.
4. Go to the Menu | System Admin | Organization Rules | Bank window.
5. Add a new bank detail for PayPal usage on the Bank tab.
Chapter 7
249
6. Add an account detail on the Account tab.
7. The values here are not being used, so you may default the mandatory elds to a
sensible value. The only important eld is Currency. Set it to USD.
8. Go to the Payment Processor tab and mention the following PayPal-related details:
f Vendor ID: <your PayPal account ID (for example, AK6REQJW3RMQY)>
f User ID: <your PayPal API username (for example, ajitkumar601_api1.gmail.
com
)>
f Password: <your PayPal API password (for example, ZUGQSLQ86GDFJKRG)>
f Accept Visa: Check
f Only Currency: USD
PayPal Integration
250
f Payment Processor Class: org.compiere.model. PP_PayPal
9. Go to the Open Items | Payment window and enter the payment details using the
following PayPal-specic details:
f Bank Account: <the bank account we created in the previous step>
f Document
Tender Type: Credit Card
Online Access: check
Credit Card: <buyer credit card number (for example,
4536523073948644)>
Verication Code: <buyer credit card's CVV number (for example, 456)>
Exp. Month: <buyer credit card exp. Month (for example, 8)>
Exp. Year: <buyer credit card exp. Year (for example, 2015)>
Account Name: <buyer name on credit card (for example, Ajit Kumar)>
Account Street: <buyer credit card street address (for example, "1 Main
St")>
Account City: <buyer credit card city in address (for example, San Jose)>
Chapter 7
251
Account Zip/Postal: <buyer credit card postal code in address (for example,
95131)>
Account State: <buyer credit card state in address (for example, CA)>
Account Country: <buyer credit card country in address (for example,
United States)>
10. Click on the Online Process button to process the PayPal payment. After successful
processing, the payment amount will appear in the Result section under the Status
eld group and the Document section will become read-only.
PayPal Integration
252
11. Verify that you have received a payment notication in your Test Email section of the
PayPal Sandbox.
12. Go to the My Account | History tab of the Website Payments Pro account. You will
see the recently posted payment details in your payment history.
How it works...
ADempiere provides the PaymentProcessor abstract class, which facilitates the online
payment processing. ADempiere already has the integration with VeriSign's Payow Pro, which
extends the PaymentProcessor class. The heart of the class is the processCC method,
which is expected to process the credit card payments. Our PP_PayPal class also extends
the PaymentProcessor class. In the processCC method of PP_PayPal, we have currently
provided support only for the Visa type of credit card if the payment transaction is of the type
Sale. We have used the DoDirectPayment API to post payments to a PayPal account whose
Chapter 7
253
credentials are set up on the Payment Processor tab of the Bank window. Currently, the API
signature is hardcoded in the code, which I expect it will be replaced with the usage of the API
certicate le in the live environment.
There's more...
PayPal provides other APIs to capture a payment, authorize a payment, and so on, which can
be used to support the different transaction types listed by ADempiere.
Integrating PayPal Instant Payment
Notication (IPN)
If you are interested in receiving asynchronous notication from PayPal about the payments
made to a PayPal account, then this recipe intends to cover that. This is a very useful feature
provided by PayPal to integrate and automate our back-ofce operation (for example, initiate
shipping as soon as the payment is conrmed).
Getting ready
Make sure your machine is accessible on the internet, as it is a must to implement IPN.
How to do it...
1. Install XAMPP, which provides the Apache Web server, on the machine. You may refer
to Chapter 5, VirtueMart Integration, for the steps. Say, we have installed the XAMPP
in c:\xampp
2. Create an IPN listener by referring to PayPal's IPN guide: https://cms.paypal.
com/cms_content/US/en_US/files/developer/IPNGuide.pdf.
This guide provides a PHP implementation of the listener, which you can use to follow
this recipe. Say, we have named the listener IPNListener.php.
3. Keep the IPNListener.php in your Web server folder, which is accessible, say,
in c:\xampp\htdocs. In this case, the URL that we will use with PayPal will be
http://<your host address>/IPNListener.php.
4. On the PayPal Sandbox page, select the Website Payments Pro account and go to
the My Account | Prole page of the same.
5. Click on the Instant Payment Notication preferences link under the Selling
preferences section.
6. Click on Choose IPN Settings and enter the URL of your IPN listener and select the
Receive IPN messages radio before saving the setting.
Down l o a d f r o m Wow ! e B o o k < www. w o w e b o o k . com>
PayPal Integration
254
7. Go to the Test Tools page on your PayPal Sandbox page and click on the IPN
Simulator to launch the simulator.
8. Fill in the IPN Handler URL and payment-related values and click on the
Send IPN button.
If your listener URL is valid and the listener is running, you will see the IPN successfully sent
message on the top.
How it works...
There are various PayPal APIs, which send the payment notication to a designated URL, for
example, DoDirectPayment. For development and testing, we have used the IPN simulator
provided by PayPal so that we can generate any notication without waiting for API integration
and then posting a transaction using that. Our IPNListener receives the request from
the IPN simulator, which POSTs the list of name-value pairs containing the payment-related
information (for example, buyer information, seller information, item detail, and so on).
The listener then sends the request back to PayPal for verication. PayPal may return either
VERIFIED or INVALID. In the case of VERIFIED, we are okay to proceed with further
processing—for example, we may store the complete IPN request (name-value pair details)
in a database and provide a view for the user to look at those notications, create a shipment
request in ADempiere, and so on.
8
Equifax Integration
In this chapter, we will cover:
1. Equifax session service
2. Equifax address matching service
3. Equifax bank validation service
4. Equifax company matching service
5. Equifax consumer bureau service
6. Equifax password change service
Introduction
Say, you are a loan provider company and you would like to have a check on the customer's
credit score to gure out whether a loan can be given to the customer, and if so, how much
loan can be granted. You may also like to avoid or detect a potential fraud to minimize losses.
All these are needed to basically cover the risk in the business. Equifax Inc. is one such credit
reporting agency, besides, Experian and TransUnion. Each one of them provides APIs and
mechanisms to report credit detail, programmatically. In this chapter, we will understand
the Equifax APIs and what it would take to integrate it in any application, in general, and
ADempiere, in particular.
Equifax is used to nd out the information pertaining to customers and to evaluate their credit
statuses and the validity of the information provided by the customers. It provides consumer
data taken from a wide range of sources to enable its users to make informed decisions. To
the user, Equifax provides the following types of services:
f Session service: This provides a set of services related to the session management
with Equifax. The logon request provides the session token, which is used in all the
subsequent requests.
Equifax Integration
256
f Address matching service: This is useful in address matching (current as well as
previous) to nd the relevant individual.
f Bank validation service: It is useful to validate the bank details based on the bank
account number and sort code provided during the request.
f Company matching service: Useful for correctly targeting any companies used in a
commercial application.
f Consumer bureau service: Useful in nding out the address, credit score, and fraud
scan details of a customer.
For the purpose of simplicity, we will not cover any details of Equifax as it is already explained
in the Equifax documents. You shall get access to the documents after you have registered
yourself with Equifax on
http://www.equifax.com. Also, there are various scenarios
where Equifax can be used in a business. So, without getting into the specics of the
scenarios, chapter shows how to work with the Equifax APIs.
Upon registration, you shall get the following information, which is required to execute
the APIs:
f Client reference
f Domain ID
f User ID
f Password
Also, note that Equifax is not applicable to all countries. You may have to look at their website
in order to nd out whether the country, for which you are planning to implement the Equifax
integration, is supported by Equifax. For this chapter, I have considered the UK.
In this chapter, we will understand the different Equifax APIs, which are available for
integration and also learn what the typical requests and responses of each of the APIs are.
Equifax session service
Upon a successful logon, Equifax provides a session token which needs to be used on the
subsequent API calls. While the token is useful to the application developer, Equifax uses this
to keep track of the API usage and managing the connections.
Session service has the following requests:
f Ping: This is used to determine whether the Equifax XML interface is available
f Logon: This is used to logon the user to the Equifax NTG application architecture.
The success response contains the session token
f Log off: This is used to log off the session identied by the supplied session token
f Change password: It is used to change the password
Chapter 8
257
In this recipe, we will see the steps and code required to invoke an Equifax session service
API. Ping is kept outside this recipe due to its simplicity, whereas, Change password
is covered in a separate recipe, as it needs some more attention besides just changing
the password.
Getting ready
1. Make sure you have the adempiere_360 project set up in Eclipse. You may refer
to
Chapter 1, Preparing the Ground if it is not already done.
2. Download the latest stable version of Apache HttpComponents from
http://hc.apache.org/ and extract it into a folder, say, C:\apache\
httpcomponents-client-4.0.3.
3. Add the JAR les to the adempiere_360 project's Build Path from C:\apache\
httpcomponents-client-4.0.3\lib.
How to do it...
1. Create the EquifaxImpl.java class le.
2. Using Apache HttpComponent, create a method sendHttpRequest to send a HTTP
POST request to Equifax URL, and save it in the le:
private String sendHttpRequest(String url, List <NameValuePair>
nvps) throws Exception {
HttpClient httpclient = new DefaultHttpClient();
HttpPost httppost = new HttpPost(url);
httppost.setEntity(new UrlEncodedFormEntity(nvps, HTTP.UTF_8));
HttpResponse response = httpclient.execute(httppost);
HttpEntity resEntity = response.getEntity();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
if (resEntity != null) {
resEntity.writeTo(baos);
}
if (resEntity != null) {
resEntity.consumeContent();
}
httpclient.getConnectionManager().shutdown();
return baos.toString();
}