Create recurring schedule data.
Setting Up Recurring Payment Schedules
Merchants who bill the same amount to the same customers every month can streamline their payment process with our recurring payment solution. This automated system charges customers on a regular basis by deducting funds from their credit cards, ensuring seamless product or service usage.
Command
curl --location --request POST
'https://apis.paysolutions.asia/recurring/api/restpayrecurring' \
--header 'secretkey: {merchant-secret-key}' \
--header 'apikey: {merchant-api-key}' \
--header 'Content-Type: application/json' \
--data-raw '{
"merchantID": "last-five-digit of merchant id",
"refno": "current refno. number 12 digit"",
"total": "number total value"
}'
Method
POST
URL
https://apis.paysolutions.asia/recurring/api/restpayrecurring
Header
Name | Description |
---|---|
secretkey | Merchant secret key |
apikey | Api Key |
Content-Type | application/json |
JSON Value
Name | Description |
---|---|
merchantID | Last 5 digits of Merchant Id |
refno | Current ref no. number 12 digit **Unique |
total | Price |
Response : Success
{
"success": 200,
"message": "Success",
"data": {
"merchantID": "last-five-digit of merchant id",
"refno": "number 12 digit",
"scheduleDate": "2023-03-04",
"total": 300,
"occurranceNo": 3
}
}
Response : Fail
{
"message": "This Ref. No is already exists.",
"data": {
"merchantID": "last-five-digit of merchant id",
"refno": "number 12 digit"
"total": 300
}
}
Create recurring schedule data with specific date
Command
curl --location --request POST
'https://apis.paysolutions.asia/recurring/api/restpayrecurring-scheduledate' \
--header 'secretkey: {merchant-secret-key}' \
--header 'apikey: {merchant-api-key}' \
--header 'Content-Type: application/json' \
--data-raw '{
"merchantID": "last-five-digit of merchant id",
"refno": "current refno. number 12 digit",
"total": "number total value",
"schedule_date": "2021-12-31"
}'
Method
POST
URL
https://apis.paysolutions.asia/recurring/api/restpayrecurring-scheduledate
Header
Name | Description |
---|---|
secretkey | Merchant secret key |
apikey | Api Key |
Content-Type | application/json |
JSON Value
Name | Description |
---|---|
merchantID | Last 5 digits of Merchant Id |
refno | Current ref no. number 12 digit **Unique |
total | Price |
schedule_date | Schedule Payment Date |
Response : Success
{
"success": 200,
"message": "Success",
"data": {
"merchantID": "last-five-digit of merchant id",
"refno": "number 12 digit",
"scheduleDate": "2023-03-04",
"total": 300,
"occurranceNo": 3
}
}
Response : Fail
{
"message": "This Ref. No is already exists.",
"data": {
"merchantID": "last-five-digit of merchant id",
"refno": "number 12 digit"
"total": 300
}
}
Reviewing Recurring Payment Orders
To review recurring payment orders, merchants can log in to https://controls.paysolutions.asia and navigate to Recurring Service > Create Recurring. Press the "Detail" button to view the details of a specific recurring order.
System show status of "waiting" for recurring payment order.
Recurring Schedule Status detail
JSON Value
Name | Description |
---|---|
Success | The recurring payment has been successfully processed and charged to your customer's account. |
Waiting | The recurring order is pending processing and will be billed shortly. |
Cancel | The recurring order has been canceled and will no longer be processed. |
Fail | The recurring order cannot be processed due to insufficient funds or an exceeded card limit. |
Upon completion of the scheduled recurring payment run between 07:30 and 09:00 AM daily, the Pay Solutions system sends a postback to the merchant's website based on the configuration in controls.paysolutions.asia, including additional parameters.
- recrefno = recurring refno
- recocurranceno = count occurrence recurring