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><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.

<p class="slate-p " >(for merchant action)</p><p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><em class="slate-italic">It is also reminded that this function is mainly used when the consumer request that he or she wants to quit the card membership account, and the merchant will initiate the deletion of the card membership account (and deletes all card-bound information)</em></div></li><li class="slate-li " ><div style="position:relative"><em class="slate-italic">Therefore, it is recommended that the merchant website should cooperate with and fully inform consumers of relevant rights and obligations.</em></div></li></ul><p class="slate-p " ><strong class="slate-bold">  URL of Testing Platform:</strong></p><div class="code-block-wrapper"  style="width:100%;min-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-shell keep-markup drop-tokens"><div class="slate-code_line"><a href="https://test.paydollar.com/b2cDemo/eng/merchant/api/MemberPayApi.jsp" target="_self">https://test.paydollar.com/b2cDemo/eng/merchant/api/MemberPayApi.jsp</a></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Integration Parameters</strong></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:155px;">Title</div><div style="width:344px;">Description</div><div style="width:137px;">Title</div><div style="width:146px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:155px"><col style="width:344px"><col style="width:137px"><col style="width:146px"><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 " ><span style="background-color:white;"><strong class="slate-bold">Input /Return</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:white;"><strong class="slate-bold">Parameters (Required Fields are in Bold typeface) (Case Sensitive)</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:white;"><strong class="slate-bold">Data Type</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:white;"><strong class="slate-bold">Expected Value</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:white;"><strong class="slate-bold">Descriptions</strong></span></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Input</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">merchantId</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The merchant ID we provide </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">merchantApiId</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (20)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The login ID of merchant API </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">password</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (20)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The password of merchant API </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">actionType</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (20)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >“Delete” </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The action type </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">memberId </strong></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 " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Merchant member Id </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Output</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >responsecode </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 " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Response code for the API request </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >responsemessage</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 " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Detail message for the response status </p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px">All the return parameters will be in XML format </p><div class="code-block-wrapper"  style="width:100%;min-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"><memberpayresponse> 
<action>Delete</action> 
<responsestatus> 
<responsecode>0</responsecode> 
<responsemessage>OK</responsemessage> 
</responsestatus> 
<response/> 
</memberpayresponse> </textarea><code class="language-xml keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

All the return parameters will be in XML format 

Sections