Project

General

Profile

Specification » History » Version 9

chin-yeh, 01/11/2011 12:39 PM

1 2 chin-yeh
{{toc}}
2
3 1 chin-yeh
h1. Specification
4 2 chin-yeh
5 5 chin-yeh
The chosen integration method is *Customer Link*. The consumer enters payment information on GlobalCollect's hosted payment pages and GlobalCollect will forward the payment result to the merchant through *Payment Status Communicator* (PSC).
6
7 6 chin-yeh
h2. Introduction
8 1 chin-yeh
9 6 chin-yeh
*Payment Flow*:
10 1 chin-yeh
!flow_diagram.jpg!
11 6 chin-yeh
12
13
h3. Java Package Name
14
15
Package name:
16
<pre>
17
my.com.eCosway.globalcollect
18
</pre>
19
20
h3. Table(s) used
21
22
<pre>
23
GLOBALCOLLECT_INTERFACE
24
</pre>
25
26
h2. Configuration
27
28
The GlobalCollect's *Customer Link* requires the merchant to provide the following URL:
29
* *Return URL* - A link to be displayed on GlobalCollect's payment pages. 
30
* *PSC URL* - GlobalCollect sends the payment information to this URL after the consumer has completed a payment attempt successfully.
31
32
h3. globalcollect.properties
33
34
This properties file is located at:
35
<pre>
36
resources/properties/uk/globalcollect.properties
37
</pre>
38
39
*Properties Description*:
40
|_.Property Name|_.Description|
41
|cl.url|The API URL for Customer Link|
42
|merchant.id|The merchant ID (provided by GlobalCollect)|
43
|merchant.ip|The merchant's public IP address|
44
|order.api.version|The API version of INSERT_ORDER|
45
|order.status.api.version|The API version of GET_ORDERSTATUS|
46
|currency.code|3 letter currency code (ISO-4217)|
47
|country.code|2 letter country code|
48
|language.code|2 letter language code (ISO-639)|
49
50
h2. Programming
51
52
This section contains 3 parts:
53
* Generate redirect URL - describes how to generate the redirect URL
54
* Back URL - describes how to handle the returned consumer
55
* PSC URL - describes how to capture the payment information
56
57 9 chin-yeh
h3. Required libraries
58
59
Apache HttpClient:
60
* httpclient-4.0.3.jar 
61
* httpcore-4.0.1.jar
62
* httpmime-4.0.3.jar
63
64
Download link:  http://hc.apache.org/downloads.cgi
65
66 6 chin-yeh
h3. Generate redirect URL
67
68
This URL will be used to redirect the consumer to GlobalCollect's payment pages. 
69
70
*Step-by-Step:*
71
# Prepare  the following parameters:
72
** *connection* - an established database connection
73
** *orderId* - the unique order ID, 20 alphanumeric characters
74
** *amount* - the order amount in cents, and integer values only
75
# Pass the above parameters to the following interface:
76
<pre>
77
String redirectUrl = PaymentUtils.genRedirectPaymentUrl(connection, orderId, amount);
78
</pre>
79
# Insert the order ID information into session.
80
# Redirect the consumer to the generated URL using *JavaScript* or *HttpServletResponse.sendRedirect*. 
81
82
h3. Back URL
83
84
The back URL acts as receipt URL also. This is where the consumer will be redirected to after completed the payment.
85
86 8 chin-yeh
As GlobalCollect will not forward payment information to the URL, one has to obtain the order details via the active session. The following guide assumes the order ID is stored in the session.
87 6 chin-yeh
88
*Step-by-Step:*
89
# Prepare the following parameters:
90
** *connection* - an established database connection
91
** *orderId* - the unique order ID, 20 alphanumeric characters
92
# Pass the above parameters to the following interface:
93
<pre>
94
String orderId = (String) session.getAttribute("test_ord_id");
95
PaymentUtils.persistPaymentStatusForReceipt(connection, orderId);
96 1 chin-yeh
</pre>
97 8 chin-yeh
# And then, one can obtain the payment status in the interface table (see [[Specification#Table-used|Table Name]]);
98 6 chin-yeh
99
h3. PSC URL
100
101
For every payment transaction with the status 500 and above, GlobalCollect will post the payment information to the PSC URL.
102
103
*Step-by-Step*:
104
# Prepare the following parameters:
105
** *connection* - an established database connection
106
** *request* - the HttpServletRequest object
107
# Pass the above parameters to:
108
<pre>
109
PaymentUtils.persistPaymentStatusForPsc(dataBean.getConnection(), request);
110
</pre>
111
# *[Important]* The PSC must not contains any HTML element except a *'OK'* string e.g., 
112
<pre>
113
out.print("OK");
114 1 chin-yeh
</pre>
115 6 chin-yeh
 
116 8 chin-yeh
h2. FAQ
117 7 chin-yeh
118
*PSC:*
119
* GlobalCollect post the payment result within 2 minutes after completed payment
120
* The PSC URL must be a HTTPS URL
121
* Only those payment result with status 500 or above will be posted to PSC URL.
122
* The number of retry attempt is 10 and retry interval is 2 minutes. When reached the maximum retry attempt, the PSC posting will be disabled.