AsiaPay Limited

Introduction

Client Post Through Browser

Integration Parameters 

Sample Code

Direct Client Side Connection

Integration Parameters

Server Side Direct Connection

Functions of Membership API

Introduction of API functions

Query Membership

Add Membership

Update Membership

Delete Membership

Functions of MemberPay API

Query MemberPay Account

Add MemberPay Account

Update MemberPay Account

Delete MemberPay Account

Change MemberPay Account Password (Password Mode only)

Generate MemberPay one-time token

Reset MemberPay static token (Static Token Mode Only)

NCCC Card management

Card Management

Blank

Integration Guide for Membership and MemberPay v2.2

<p class="slate-p " ></p><h1 class="slate-h1 " ><strong class="slate-bold">Welcome to</strong> <span style="color:#ff6600"><strong class="slate-bold">Integration Guide for Membership and MemberPay</strong></span></h1><p class="slate-p " ></p>

Integration Guide for Membership and MemberPay

<p class="slate-p " ></p><p class="slate-p " >It is the most popular connection method among merchants. The advantage of this connection method is simple and speedy. On the other hand, payment transaction flow is ready to use. Merchant can kick off the web site on-the-fly with just a small scale integration.</p><h3 class="slate-h3 " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Scope and Compatibility</strong></span></h3><p class="slate-p " >This connection is designed for merchants who have <em class="slate-italic">Online Shopping Cart System</em>. The routine is HTML-based with Javascript and should be widely applicable to on-line shopping cart software and architecture, whose technical specifications and varieties are beyond the scope of this document. Compatibility with shopping cart software is yet to be exhaustively given and would not be included in the scope of this document.</p><p class="slate-p " >The compatible version of the software code is as follow:</p><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:499px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:499px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Software Code</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Version</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >HTML</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >4.0</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >JavaScript</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1.3</p></td></div></tr></tbody></table></div><p class="slate-p " >The version compatibility of the software code with popular browser software is as follow:</p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:498px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:498px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Browser</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Version</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Microsoft Internet Explorer </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >5.0 or above</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mozilla Firefox</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >3.0 or above</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Google Chrome</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >5.0 or above</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Safari</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >4.0 or above</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Static Token Mode</strong></span></h3><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697101836424.png" style="
              width:578px;
	            height:796px;
	            aspect-ratio:578 / 796"
         /></div><p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Password Mode:</strong></span></h3><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697102040836.png" style="
              width:544px;
	            height:644px;
	            aspect-ratio:544 / 644"
         /></div><p class="slate-p " ></p><p class="slate-p " ></p>

It is the most popular connection method among merchants. The advantage of this connection method is simple and speedy. On the other hand, payment transaction flow is ready to use. Merchant can kick off the web site on-the-fly with just a small scale integration.

This connection is designed for merchants who have 

. The routine is HTML-based with Javascript and should be widely applicable to on-line shopping cart software and architecture, whose technical specifications and varieties are beyond the scope of this document. Compatibility with shopping cart software is yet to be exhaustively given and would not be included in the scope of this document.

The compatible version of the software code is as follow:

Title

Description

The version compatibility of the software code with popular browser software is as follow:

<p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Integration Procedures</strong></span></h3><p class="slate-p " >For Direct Client Side Integration, merchant required to use the MemberShip API to create the membership with memberID first. Afterward, you need to post the required parameters to our payment page URL with the one-time token and then get back the result by using data feed.</p><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697107161162.png" style="
              width:706px;
	            height:807px;
	            aspect-ratio:706 / 807"
         /></div><p class="slate-p " ></p><p class="slate-p " ></p>

For Direct Client Side Integration, merchant required to use the MemberShip API to create the membership with memberID first. Afterward, you need to post the required parameters to our payment page URL with the one-time token and then get back the result by using data feed.

<p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Integration Procedures</strong></span></h3><p class="slate-p " >For Server Side Integration, merchant required to use the MemberShip API to create the membership with memberID first. Afterward, you need to post the required parameters to our payment page URL and then get back the result by using data feed.</p><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697107990416.png" style="
              width:610px;
	            height:570px;
	            aspect-ratio:610 / 570"
         /></div><p class="slate-p " ></p><p class="slate-p " ></p>

For Server Side Integration, merchant required to use the MemberShip API to create the membership with memberID first. Afterward, you need to post the required parameters to our payment page URL and then get back the result by using data feed.

<p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">The following are the parameters for integration. PayDollar PayGate is case sensitive. Make sure the typeface is correct. When a transaction is finish, the system will return customer a payment message on the page created by merchant.</p><p class="slate-p " ><strong class="slate-bold">Required Parameter ( with UTF-8 Encoding ) for connect to our payment interface</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:207px;">Title</div><div style="width:170px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:207px"><col style="width:170px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Data Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Descriptions</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >orderRef</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (35)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Merchant‘s Order Reference Number</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number (12,2)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Total amount your want to charge the customer [ Up to 2 decimal place ]</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >currCode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (3)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The currency of the payment:</p><p class="slate-p " >“344” – HKD</p><p class="slate-p " >“840” – USD</p><p class="slate-p " >“702” – SGD</p><p class="slate-p " >“156” – CNY (RMB)</p><p class="slate-p " >“392” – JPY</p><p class="slate-p " >“901” – TWD </p><p class="slate-p " >“036” – AUD</p><p class="slate-p " >“978” – EUR</p><p class="slate-p " >“826” – GBP</p><p class="slate-p " >“124” – CAD</p><p class="slate-p " >“446” – MOP</p><p class="slate-p " >“608” – PHP</p><p class="slate-p " >“764” – THB</p><p class="slate-p " >“458” – MYR</p><p class="slate-p " >“360” – IDR</p><p class="slate-p " >“410” – KRW</p><p class="slate-p " >“682” – SAR</p><p class="slate-p " >“554” – NZD</p><p class="slate-p " >“784” – AED</p><p class="slate-p " >“096” – BND</p><p class="slate-p " >“704” – VND</p><p class="slate-p " >“356” – INR</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >lang</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (1)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The language of the payment page : </p><p class="slate-p " >“E” - English</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >securityCode</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (4)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Credit Card Verification Code</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">VISA: CVV2 (3-digit)</div></li><li class="slate-li " ><div style="position:relative">MasterCard: CVC2 (3-digit)</div></li><li class="slate-li " ><div style="position:relative">JCB: CAV2 (3-digit)</div></li><li class="slate-li " ><div style="position:relative">American Express: 4DBC (4-digit)</div></li></ul></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >merchantId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The merchant ID we provide to you</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >payType</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (1)
(“N”,”H”)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment type:</p><p class="slate-p " >“N” – Normal Payment (Sales)</p><p class="slate-p " >“H” – Hold Payment (Authorize only)</p><p class="slate-p " >For merchants who use authorize mode, please be reminded to perform the CAPTURE action as soon as the transaction is confirmed as valid. Once captured, the customer&apos;s credit card will be debited in coming bank settlement processing. If the merchant does not capture/reverse the authorized transaction over 14 days, the credit limit will be released to the cardholder after a time period which is subjected to card issuing bank Merchant may capture/reverse the authorized transaction in the merchant administration site &gt; Operation &gt; Transaction Detail.</p><p class="slate-p " >
Remark: Hold Payment is not available for 99BILL, ALIPAY, CHIANPAY, PAYPAL, PPS, TENPAY, MEPS</p><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >memberPay_service</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text(1)
(“T”,”F”)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >MemberPay service indicator</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >memberPay_token</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#FE0000">The One-Time Token which is generated by MemberPay API (Generate MemberPay one-time token)</span></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >memberPay_memberId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text(50)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Member Id</p></td></div></tr></tbody></table></div><p class="slate-p " ><strong class="slate-bold">Optional Parameter for connect to our payment interface</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:210px;">Title</div><div style="width:173px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:210px"><col style="width:173px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Data Type</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Descriptions</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >remark</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An additional remark field that will appear in the confirmation email and transaction detail report to help you to refer the order</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >secureHash</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (40)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Secure hash is used to authenticate the integrity of the transaction information and the identity of the merchant. It is calculated by hashing the combination of various transaction parameters and the Secure Hash Secret.</p><p class="slate-p " >*Applies to merchants who registered this function only. For more information, please refer to section 4.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

The following are the parameters for integration. PayDollar PayGate is case sensitive. Make sure the typeface is correct. When a transaction is finish, the system will return customer a payment message on the page created by merchant.

Required Parameter ( with UTF-8 Encoding ) for connect to our payment interface

Optional Parameter for connect to our payment interface

<p class="slate-p " ></p><p class="slate-p " >As different type of programming language have different syntax, so we just propose the method to connect to our payment page. To connect, we suggest you to use server side posting:</p><p class="slate-p " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Sample code for server post by using java:</strong></span></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-java keep-markup drop-tokens"><div class="slate-code_line">// Set up the post data</div><div class="slate-code_line">String postData =</div><div class="slate-code_line">&quot;merchantId=1&amp;orderRef=test&amp;amount=1&amp;currCode=344&amp;pMethod=VISA&amp;lang=E&amp;securityCode=</div><div class="slate-code_line">123&amp;payType=N&amp;remark=test&amp;memberPay_service=T&amp;memberPay_token=YF8TM7JgdRuxQXI3OyTZY</div><div class="slate-code_line">b0kbgHb1oyq1llqtiysCL1q9GqpinTZq5K1jqKfEVey9lHgLf0rgDtPEHo3RDJP3w==&amp;memberPay_membe</div><div class="slate-code_line">rId=member01”;</div><div class="slate-code_line">// Post to payment page</div><div class="slate-code_line">strResult = ServerPost.post(postData,</div><div class="slate-code_line">https://www.paydollar.com/b2c2/eng/directPay/payComp.jsp );</div><div class="slate-code_line">// Extract the payment status from strResult</div><div class="slate-code_line">...</div><div class="slate-code_line">// Finish</div><div class="slate-code_line">************************************************************************</div><div class="slate-code_line">public class ServerPost</div><div class="slate-code_line">{</div><div class="slate-code_line">static public String post( String ip_postData, String ip_pageUrl)</div><div class="slate-code_line">{</div><div class="slate-code_line">try</div><div class="slate-code_line">{</div><div class="slate-code_line">String strResult = &quot;&quot;;</div><div class="slate-code_line">URL url = new URL(ip_pageUrl);</div><div class="slate-code_line">URLConnection con = url.openConnection(); //from secure site</div><div class="slate-code_line">if(con instanceof com.sun.net.ssl.HttpsURLConnection){</div><div class="slate-code_line">((com.sun.net.ssl.HttpsURLConnection)con).setSSLSocketFactory</div><div class="slate-code_line">(SSLSocketFactory)SSLSocketFactory.getDefault());</div><div class="slate-code_line">}</div><div class="slate-code_line">con.setDoOutput(true);</div><div class="slate-code_line">con.setDoInput(true);</div><div class="slate-code_line">// Set request headers for content type and length</div><div class="slate-code_line">con.setRequestProperty(</div><div class="slate-code_line">&quot;Content-type&quot;,</div><div class="slate-code_line">&quot;application/x-www-form-urlencoded&quot;);</div><div class="slate-code_line">con.setRequestProperty(</div><div class="slate-code_line">&quot;Content-length&quot;,</div><div class="slate-code_line">String.valueOf(ip_postData.length()));</div><div class="slate-code_line">// Issue the POST request</div><div class="slate-code_line">OutputStream outStream = con.getOutputStream();</div><div class="slate-code_line">outStream.write(ip_postData.getBytes());</div><div class="slate-code_line">outStream.flush();</div><div class="slate-code_line">// Read the response</div><div class="slate-code_line">InputStream inStream = con.getInputStream();</div><div class="slate-code_line">while (true)</div><div class="slate-code_line">{</div><div class="slate-code_line">int c = inStream.read();</div><div class="slate-code_line">if (c == -1)</div><div class="slate-code_line">break;</div><div class="slate-code_line">strResult = strResult + String.valueOf((char)c);</div><div class="slate-code_line">}</div><div class="slate-code_line">inStream.close();</div><div class="slate-code_line">outStream.close();</div><div class="slate-code_line">return strResult;</div><div class="slate-code_line">}</div><div class="slate-code_line">catch (Exception e)</div><div class="slate-code_line">{</div><div class="slate-code_line">System.out.print(e.toString());</div><div class="slate-code_line">return null;</div><div class="slate-code_line">}</div><div class="slate-code_line">}</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ><em class="slate-italic">All the source code in this document are the property of AsiaPay (HK) Limited. Any use, modification and adaptation to the code should be reported to and approved by AsiaPay (HK) Limited. AsiaPay (HK) Limited do not have any liability in any lose to the party using the source code.</em></p><p class="slate-p " ><span style="color:rgb(255, 102, 0)"><strong class="slate-bold">Kick off</strong></span></p><p class="slate-p " >After the integration has been completed, it is ready to launch your e-commerce web to serve your</p><p class="slate-p " >customers. Please copy the following <strong class="slate-bold">TESTING URL</strong> for Direct Connect Server Post method:</p><p class="slate-p " ><a href="https://test.paydollar.com/b2cDemo/eng/directPay/payComp.jsp" target="_self"><code class="slate-code">https://test.paydollar.com/b2cDemo/eng/directPay/payComp.jsp</code></a></p><p class="slate-p " ></p>

As different type of programming language have different syntax, so we just propose the method to connect to our payment page. To connect, we suggest you to use server side posting:

Sample code for server post by using java:

All the source code in this document are the property of AsiaPay (HK) Limited. Any use, modification and adaptation to the code should be reported to and approved by AsiaPay (HK) Limited. AsiaPay (HK) Limited do not have any liability in any lose to the party using the source code.

After the integration has been completed, it is ready to launch your e-commerce web to serve your

<p class="slate-p " ></p><h1 class="slate-h1 " ><strong class="slate-bold">Introduction</strong></h1><p class="slate-p slate-indent-0" style="0px">There are totally two API functions provided:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Card management page (for customer action)</div></li><li class="slate-li " ><div style="position:relative">Delete MemberPay Account (for merchant action)</div></li></ul><p class="slate-p slate-indent-0" style="0px">To connect to our system,</p><p class="slate-p slate-indent-0" style="0px">For Card management page, you need generate a one-time token and post the required parameters by HTML form or Name-value pair posting to our NCCC card management
API web page and redirect to NCCC card management page.</p><p class="slate-p slate-indent-0" style="0px">For delete memberpay account, you need to post the required parameters by HTML form posting to our merchant API web page and then get back the processing result from that page. You can implement it by server-side html post.</p><p class="slate-p " ></p>

There are totally two API functions provided:

For Card management page, you need generate a one-time token and post the required parameters by HTML form or Name-value pair posting to our NCCC card management
API web page and redirect to NCCC card management page.

For delete memberpay account, you need to post the required parameters by HTML form posting to our merchant API web page and then get back the processing result from that page. You can implement it by server-side html post.

Sections