AsiaPay Limited

Introduction

Sechedule Payment

Function of schedule payment

Schedule Payment API

Add Schedule Payment

Change the credit card information of schedule payment record

Change the amount of schedule payment record

Delete schedule payment record

Change the date of schedule payment record (Only support “Month” schedule type)

Query function of schedule payment record

Change the schedule type of schedule payment record

Suspend / Reactivate schedule payment record

Theneo Demo TechCrunch

User Guide for Schedule Payment API

Production

<p class="slate-p " ></p><p class="slate-p " ></p><h1 class="slate-h1 " ><strong class="slate-bold">Welcome to </strong><span style="color:#ff6600"><strong class="slate-bold">User Guide for Schedule Payment API</strong></span></h1><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >Schedule payment is an additional function of Paydollar E-Commerce Service. It can help merchant to
pre-define different type of schedule credit card payment e.g. Monthly or weekly fee
The System Flow of this module is as follows: -</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Merchant have to upload their member information such as Credit Card No, Expire Date, member
id, schedule type, start date, end date in file format to us from our Web-base interface.</div></li><li class="slate-li " ><div style="position:relative">Then Base on the Schedule Factor such as start date and schedule type (i.e. 3 week, 2 Month),
provide by merchant, our system will work out and proceeds the transaction via a bank to debit his/her
credit card.</div></li><li class="slate-li " ><div style="position:relative">After, finished the transaction, the system will email a transaction log to the merchant.</div></li><li class="slate-li " ><div style="position:relative">The merchant can also check that transaction via the web-base transaction report</div></li></ol><p class="slate-p " ></p>

Schedule payment is an additional function of Paydollar E-Commerce Service. It can help merchant to
pre-define different type of schedule credit card payment e.g. Monthly or weekly fee
The System Flow of this module is as follows: -

<p class="slate-p " >The Schedule Payment Report is provided for you to check all the schedule payment stored. In order to view it, you need to click the Report Button and then choose the Schedule Payment Report Link:</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/dfaa6336-c56d-4f3f-950b-3648c8f7a8b5.png" style="
              width:943px;
	            height:328px;
	            aspect-ratio:943 / 328"
         /></div><p class="slate-p " ></p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/fb13c018-0759-4f07-a1c7-718970395f41.png" style="width:auto;height:auto" /></div><p class="slate-p " >Choose your selection criteria and then click the View button to view the schedule payment match your selection criteria</p><p class="slate-p " >For schedule payment, we have 5 kinds of status:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Active</strong> - The schedule payment is active</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Suspend </strong>- The schedule payment is suspended</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Updated </strong>- The schedule payment is updated and it will not be active</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Deleted </strong>- The schedule payment is deleted</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Finished </strong>- The schedule payment is finished (end of period)</div></li></ol><p class="slate-p " ></p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/bc2fa444-bd80-46ce-b0f6-c114814ba644.jpg" style="width:auto;height:auto" /></div><p class="slate-p " >To View the Detail, click the Detail link.</p><p class="slate-p " ><strong class="slate-bold">Status of Detail Information:</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">New</strong> – The next payment to be process</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Pending - </strong>The payment is processing</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Accepted</strong> - The payment is accepted</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Rejected - </strong>The payment is rejected (Resend of this payment please refer to section 2.7</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Resent </strong>- The payment was resent.</div></li></ol><p class="slate-p " ></p>

The Schedule Payment Report is provided for you to check all the schedule payment stored. In order to view it, you need to click the Report Button and then choose the Schedule Payment Report Link:

Choose your selection criteria and then click the View button to view the schedule payment match your selection criteria

For schedule payment, we have 5 kinds of status:

To View the Detail, click the Detail link.

View Schedule Payment Report

<p class="slate-p " >In order to add a schedule payment, click on the Add button in Schedule Payment Report and then input all the required information in the Add Schedule Payment form:</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/c31a0a13-70a5-4376-a11d-e2cb0de31b55.png" style="
              width:943px;
	            height:543px;
	            aspect-ratio:943 / 543"
         /></div><p class="slate-p " >A Schedule Payment contain the following information:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:252px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:252px"><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">ield (* are required)</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"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Schedule Type</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The time interval of a schedule payment
e.g. 3 month, 10 days, 1 year</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Start Date (inclusive)</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The start date of the schedule payment and it is count inclusively
e.g. 07/01/2001
(So if your schedule type is 2 month and start date = 07/01/2001,
then the first transaction date with be 07/01/2001 and the second
transaction date is 09/01/2001)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >End Date (inclusive)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The end date of the schedule payment and it is count inclusively
(remain empty for continue charging)
e.g. 07/01/2002</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Amount</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The amount of the schedule payment</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Merchant Reference No.</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A reference number generated by merchant to identify a schedule
payment (prefer to be unique)
e.g. Mfee-32424</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Payer Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The name of the payer</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Payer Email</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The email of the payer</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 " >A remark for that schedule payment</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Pay Method</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Payment Method: VISA or MasterCard</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Account Number</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The account number of the card
e.g. 4918914107195005</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Holder Name</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The holder name of the card
e.g. David</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Expiry Date</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The Card Expiry Date
e.g. 07/2003</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Status</div></li></ul></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The status of the schedule payment:
<span style="color:#000000">Active </span>– The schedule payment is active
Suspend – The schedule payment is suspended, can be reset to
active
Updated – The schedule payment is updated and now is inactive
Deleted – The schedule payment is deleted
Finished – The schedule payment is finished (end of the schedule)</p></td></div></tr></tbody></table></div><p class="slate-p " >After filled the form, you need to click the Add button and you will see a confirmation page:</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/07895309-c797-4a37-ad0b-cb47d338b2e6.png" style="width:auto;height:auto" /></div><p class="slate-p " >Click the <strong class="slate-bold">Confirm</strong> button and the schedule payment will then be added</p><p class="slate-p " ></p>

In order to add a schedule payment, click on the Add button in Schedule Payment Report and then input all the required information in the Add Schedule Payment form:

A Schedule Payment contain the following information:

Title

Description

After filled the form, you need to click the Add button and you will see a confirmation page:

 button and the schedule payment will then be added

Add Schedule Payment by admin

In order to add a schedule payment by your customer with a first time transaction, you need to pass some additional parameter to our payment gateway receive page. And you can choose one of the following integration methods: Client Post through Browser or Direct Server Side Connection.

Optional Parameter for connect to our payment page

After you have passed the above parameters to our payment page, this transaction will be processed and will be treated as the first schedule payment of the start date if the transaction is accepted.

After the integration has been completed, it is ready to launch your e-commerce web to serve your customers. Please copy the following PRODUCTION URL for client post method:

Please copy the following TESTING URL for client post method:

Required Parameter for connect to our payment page

Parameter For 3D Transaction (Need to install MPI Server Software at Merchants’ site)

After the integration has been completed, it is ready to launch your e-commerce web to serve your customers. Please copy the following PRODUCTION URL for direct server side connection method:

Please copy the following TESTING URL for direct server side connection method:

So for example if you submit the transaction at 1/10/2002 and set the start date to be 1/20/2002 and the schedule period is 1 day, then the transaction processed will be treated as the first transaction of the schedule payment (1/20/2002) and the next schedule payment is on 1/21/2002.

Add Schedule Payment by customer

<p class="slate-p " >In order to update or delete a schedule payment, click on the Update link in the Schedule Payment Report to open the Update Schedule Payment Form:</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/f8986d03-4f76-4932-bf94-6cdebba1b07f.png" style="
              width:943px;
	            height:1015px;
	            aspect-ratio:943 / 1015"
         /></div><p class="slate-p " >To delete a schedule payment, you need to change the <strong class="slate-bold">Status </strong>to <strong class="slate-bold">Deleted</strong>.</p><p class="slate-p " >After changed the information, click the Update button and then click the Confirm button to confirm the changes:</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/4041ad92-ecdb-4896-af80-55736f24ebff.png" style="
              width:943px;
	            height:759px;
	            aspect-ratio:943 / 759"
         /></div><p class="slate-p " ><strong class="slate-bold">Remark</strong>: When you update a schedule payment, a new schedule payment record will be added and the old will be changed to status Updated and will be inactive</p><p class="slate-p " ></p>

In order to update or delete a schedule payment, click on the Update link in the Schedule Payment Report to open the Update Schedule Payment Form:

To delete a schedule payment, you need to change the 

After changed the information, click the Update button and then click the Confirm button to confirm the changes:

: When you update a schedule payment, a new schedule payment record will be added and the old will be changed to status Updated and will be inactive

Update or Delete schedule payment

<p class="slate-p " >Step 1: Create a text file contain all the schedule payments for upload</p><p class="slate-p " >In order to upload a batch of schedule payment, you need to construct a text file will the following format:</p><p class="slate-p " >Header is required for format checking so you must provide it in the right format in the first row of the file and each field is separate by ‘Tab’ and each record is separate by ‘Enter’.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:227px;">Title</div><div style="width:388px;">Description</div><div style="width:0px;"></div></div><colgroup ><col style="width:227px"><col style="width:388px"><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">Header</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Format</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >N Schedule Item</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number of schedule type unit</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number
e.g. 3</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Schedule Type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Schedule Type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >{“Month”, “Year”, “Day”}
e.g. Month</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Start Date</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The Start Date of the schedule payment
(inclusive)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >YYYYMMDD
e.g. 20011201</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >End Date</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The End Date of the schedule payment
(inclusive)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >YYYYMMDD or Empty
e.g. 20021201</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Currency</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The Currency Code</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >{“344”}
e.g. 344</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 " >The Amount of the schedule payment</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number (10, 2)
e.g. 100.1</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Merchant Ref.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The merchant reference number to
identify the schedule payment</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (allow empty)
e.g. Mfee-13213</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Payer Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The Name of the Payer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (allow empty)
e.g. David</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Payer Email</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The Email of the Payer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (allow empty)
e.g. <a href="mailto:david@hotmail.com" target="_self">david@hotmail.com</a></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 " >Remark of the schedule payment</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Text (allow empty)
e.g. Member Fee of David</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Pay Method</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The payment method for the schedule
payment</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >{“VISA”, “Master”}
e.g. VISA</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Account</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number
e.g. 4918914107195005</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Holder</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The holder name of the card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TEXT
e.g. David Ng</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Exp Month</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The expiry month of the card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number
e.g. 8</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Exp Year</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The expiry year of the card</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number
e.g. 2001</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The status of the schedule payment</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >{“Active”,”Suspend”}
e.g. Active</p></td></div></tr></tbody></table></div><p class="slate-p " ><strong class="slate-bold">Sample file:</strong></p><p class="slate-p " >--------------You can copy the following txt in notepad and then save as a file -----------
N Schedule Item Schedule Type Start Date End Date Currency Amount Merchant Ref.
Payer Name Payer Email Remark Pay Method Account Holder Exp Month Exp
Year Status
3 Month 20010101 20011201 344 5 test1 Edward Ng <a href="mailto:edward.ng@asiapay.com.hk" target="_self">edward.ng@asiapay.com.hk</a>
testing only VISA 4918914107195005 Edward Ng 7 2003 Active
2 Month 20010201 20020201 344 2 test2 Edward Ng <a href="mailto:edward.ng@asiapay.com.hk" target="_self">edward.ng@asiapay.com.hk</a>
testing only Master 5422882800700007 Edward Ng 7 2003 Active
--------------End of the file -----------------------------------------------------------------------</p><p class="slate-p " ><strong class="slate-bold">Step 2: Upload the file</strong></p><p class="slate-p " >After created the file in your disk, you can click the Upload button in the Schedule Payment Report and then you will see the Upload Schedule Payment as follow:</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/cf4504bb-4645-4967-ab17-e4b3b41b5c3c.png" style="
              width:943px;
	            height:443px;
	            aspect-ratio:943 / 443"
         /></div><p class="slate-p " >To upload the file, click the Browse button and then select the file created before in your disk and then click the Upload button, you will then see the following screen:</p><p class="slate-p " >Click the Confirm button to transfer into our database, then the result will show</p><p class="slate-p " ></p>

Step 1: Create a text file contain all the schedule payments for upload

In order to upload a batch of schedule payment, you need to construct a text file will the following format:

Header is required for format checking so you must provide it in the right format in the first row of the file and each field is separate by ‘Tab’ and each record is separate by ‘Enter’.

--------------You can copy the following txt in notepad and then save as a file -----------
N Schedule Item Schedule Type Start Date End Date Currency Amount Merchant Ref.
Payer Name Payer Email Remark Pay Method Account Holder Exp Month Exp
Year Status
3 Month 20010101 20011201 344 5 test1 Edward Ng 


testing only VISA 4918914107195005 Edward Ng 7 2003 Active
2 Month 20010201 20020201 344 2 test2 Edward Ng 


testing only Master 5422882800700007 Edward Ng 7 2003 Active
--------------End of the file -----------------------------------------------------------------------

After created the file in your disk, you can click the Upload button in the Schedule Payment Report and then you will see the Upload Schedule Payment as follow:

To upload the file, click the Browse button and then select the file created before in your disk and then click the Upload button, you will then see the following screen:

Click the Confirm button to transfer into our database, then the result will show

Upload a batch of schedule payments

<p class="slate-p " >You can download the master records of schedule payment in a csv format by clicking the ‘Download’ button at the schedule payment report.</p><p class="slate-p " ></p>

You can download the master records of schedule payment in a csv format by clicking the ‘Download’ button at the schedule payment report.

Download Schedule Payment Master Record

<p class="slate-p " >In our system, we have a back-end process to proceeds those schedule payment transaction daily at night. After finished, we will send a email report to your email account.</p><p class="slate-p " ></p>

In our system, we have a back-end process to proceeds those schedule payment transaction daily at night. After finished, we will send a email report to your email account.

Back End Process

<p class="slate-p " >We will send an email report to your contact email if your company has schedule payment processed in that day. The report format is like that:</p><p class="slate-p " >Schedule payment of (Test Schedule Payment) on 2002-01-03</p>

We will send an email report to your contact email if your company has schedule payment processed in that day. The report format is like that:

Schedule payment of (Test Schedule Payment) on 2002-01-03

Email Notification of processing schedule payment

<p class="slate-p " >If you found that some of the transaction rejected, you need to check that is the card over card limit or the card is expired. After you have updated the credit card information of the payer, you can resend the rejected transaction by clicking the ReSend link in the Schedule Payment Detail Report of that transaction:</p><p class="slate-p " ></p>

If you found that some of the transaction rejected, you need to check that is the card over card limit or the card is expired. After you have updated the credit card information of the payer, you can resend the rejected transaction by clicking the ReSend link in the Schedule Payment Detail Report of that transaction:

Rejected transaction handling

<p class="slate-p " ></p><p class="slate-p " >The function of Schedule Payment API</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Add schedule payment (with payment type)</div></li><li class="slate-li " ><div style="position:relative">Change the credit card information of schedule payment record</div></li><li class="slate-li " ><div style="position:relative">Change the amount of schedule payment record</div></li><li class="slate-li " ><div style="position:relative">Delete schedule payment record</div></li><li class="slate-li " ><div style="position:relative">Change the start/end date of schedule payment record</div></li><li class="slate-li " ><div style="position:relative">Query function of schedule payment record</div></li><li class="slate-li " ><div style="position:relative">Change the schedule type of schedule payment record</div></li><li class="slate-li " ><div style="position:relative">Suspend / Reactivate the schedule payment record</div></li></ol><p class="slate-p " ><strong class="slate-bold">URL of Testing Platform:</strong></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">https://test.paydollar.com/b2cDemo/eng/merchant/api/schPayApi.jsp </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">1)</strong> What is the meaning of nSch parameter in AddSchPay? I understand that the examples include 1, 2 , but what do 1, 2 mean as values for nSch?</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans:</strong> e.g. if the schType=Month, and nSch=1, it means charging once every month. if schType=Month, and nSch=3, it means charging every 3 months.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">2)</strong> Given that I want to set up the subscription lasting forever until my customer cancels the subscription, so how do i set the eYear, eMonth and eDay? Are there any maximum values for these?</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans: </strong>Recurring payments would occur until terminated</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">3)</strong> what about currency? i realise that i can only set the amount in AddSchPay, but not the currency. I have previously asked this question, but it was not answered. Please advise.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans:</strong> Each currency will have a different account.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">4)</strong> is there a query function for me to retrieve each monthly transaction? I would like to know if there is a way for me to programatically retrieve the status and transaction id for the monthly subscription fee.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans: </strong>Transaction details would be available via our reporting tools, which can be downloaded as csv files.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">5)</strong> if the transaction was unsuccessful, for eg, on the 5th billing cycle, the customer&apos;s credit card bounced, do i trigger a retry?</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans:</strong> Yes</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">6)</strong> how many retries possible?</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans:</strong> No automated retries </p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">7)</strong> will the unsuccessful schedule payment be rendered as suspended?</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Ans:</strong> Yes, only for this cycle. SchedulePay will continue to try on next cycle.

</p><p class="slate-p" placeholder="Type / for widgets"></p>

 What is the meaning of nSch parameter in AddSchPay? I understand that the examples include 1, 2 , but what do 1, 2 mean as values for nSch?

 e.g. if the schType=Month, and nSch=1, it means charging once every month. if schType=Month, and nSch=3, it means charging every 3 months.

 Given that I want to set up the subscription lasting forever until my customer cancels the subscription, so how do i set the eYear, eMonth and eDay? Are there any maximum values for these?

Recurring payments would occur until terminated

 what about currency? i realise that i can only set the amount in AddSchPay, but not the currency. I have previously asked this question, but it was not answered. Please advise.

 Each currency will have a different account.

 is there a query function for me to retrieve each monthly transaction? I would like to know if there is a way for me to programatically retrieve the status and transaction id for the monthly subscription fee.

Transaction details would be available via our reporting tools, which can be downloaded as csv files.

 if the transaction was unsuccessful, for eg, on the 5th billing cycle, the customer's credit card bounced, do i trigger a retry?

 will the unsuccessful schedule payment be rendered as suspended?

 Yes, only for this cycle. SchedulePay will continue to try on next cycle.



Sections