Skip to main content

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.

Create recurring schedule

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
NameDescription
secretkeyMerchant secret key
apikeyApi Key
Content-Typeapplication/json

JSON Value

NameDescription
merchantIDLast 5 digits of Merchant Id
refnoCurrent ref no. number 12 digit **Unique
totalPrice

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

NameDescription
secretkeyMerchant secret key
apikeyApi Key
Content-Typeapplication/json

JSON Value

NameDescription
merchantIDLast 5 digits of Merchant Id
refnoCurrent ref no. number 12 digit **Unique
totalPrice
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.

Create recurring schedule

System show status of "waiting" for recurring payment order.

Create recurring schedule

Recurring Schedule Status detail

JSON Value

NameDescription
SuccessThe recurring payment has been successfully processed and charged to your customer's account.
WaitingThe recurring order is pending processing and will be billed shortly.
CancelThe recurring order has been canceled and will no longer be processed.
FailThe 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.

info
  • recrefno = recurring refno
  • recocurranceno = count occurrence recurring