GuidesAPI ReferenceSupport
API Reference

New Recurring Payment

post https://api.paysimple.com/v4/recurringpayment

Collect payments on scheduled dates for the specified AccountId.

Receipt Options

Receipt options allow setting payment receipt email settings. By default, no messages will be sent. 

...
"SuccessReceiptOptions": {
	"SendToCustomer": true,
  "SendToOtherAddresses": [ "[email protected]","[email protected]"]
}
...

SuccessReceiptOptions
SendToCustomer boolean.
If true, send receipt to email of Customer when payment request succeeds.

SendToOtherAddresses
Array of email addresses to send receipt to when payment request succeeds.

...
"FailureReceiptOptions": {
	"SendToCustomer": true,
  "SendToOtherAddresses": [ "[email protected]","[email protected]"]
}

FailureReceiptOptions
SendToCustomer boolean.
If true, send receipt to email of Customer when payment request fails.

SendToOtherAddresses
Array of email addresses to send receipt to when payment request fails.

Payment Schedule Response

All fields in the request are returned in the response, with the addition of the following properties:

PropertyTypeDescription
Idint32Uniquely identifies schedule in all API requests and responses (elsewhere ScheduleId)
ScheduleStatusstringThe current state of the schedule. Values: Active, Expired, Suspended.
NextScheduleDatedateThe next date on which the schedule will generate a payment, based on the schedule frequency. Date format YYYY-MM-DD.

📘

If you configured the schedule to start on the current day the StartDate will be the current date and the NextScheduleDate will be a future date. If the schedule was configured to start on a future date, StartDate and NextSchduleDate will be the same future date

One time future payments

To create a schedule that will make only one payment on a given date in the future, follow the following steps:

  1. Set the ExecutionFrequencyType to Annually
  2. Set the StartDate to the day you wish to make the payment
  3. Set the EndDate to the day after the StartDate.

🚧

PaySimple receipt and failed payment notifications will not be sent to the customer when a recurring payment is generated via the API. If you require these notifications, it is recommended you build your own payment scheduler process.

Language