New Recurring Payment

post

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

Collect payments on scheduled dates for the specified AccountId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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:

Property	Type	Description
Id	int32	Uniquely identifies schedule in all API requests and responses (elsewhere `ScheduleId`)
ScheduleStatus	string	The current state of the schedule. Values: `Active`, `Expired`, `Suspended`.
NextScheduleDate	date	The 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:

Set the ExecutionFrequencyType to Annually
Set the StartDate to the day you wish to make the payment
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.

Body Params

AccountId

int32

required

The system identifier for the credit card Account or ACH account used for the payment. This is the Id attribute from the credit card object or ACH account object created previously.

PaymentAmount

double

required

Amount of the payment to be charged on specified schedule.

StartDate

date

required

Date to start the schedule. Must not be in the past. If the schedule is not scheduled to run on this date, will bill on the first scheduled day.

ExecutionFrequencyType

string

required

Frequency to run the schedule. Valid values: Daily, Weekly, BiWeekly, FirstofMonth, SpecificDayofMonth, LastofMonth, Quarterly, SemiAnnually, Annually

ExecutionFrequencyParameter

int32

Required if ExecutionFrequencyType is Weekly or SpecificDayofMonth. If Weekly specifies day of week (1=Sunday; 2=Monday; 3=Tuesday; 4=Wednesday; 5=Thursday). If SpecificDayofMonth, refers to day of month. If day of the month does not exist for a given month (e.g. 30 in February), the schedule will fire on the last day of the month. However, LastofMonth is suggested for this use case to avoid confusion.

EndDate

date

The date the schedule is to stop generating payments. If not included, the schedule will default to running until manually disabled.

PaymentSubType

string

This field defaults to Moto for credit card payments and Web for ACH payments if not included or left null. CC Valid Values: Moto. ACH Valid Values: Web, Tel, Ppd, Ccd.

InvoiceNumber

string

The invoice number attached to the payment. If the number provided is a invoice number of an existing PaySimple invoice, the associated InvoiceId will be attached to the payment and the payment will be applied to the invoice. Max 50 characters. NOTE: Invoice creation and management is not currently available via the API.

FirstPaymentAmount

double

Custom payment amount that is executed prior to the start of the schedule. Enter a number only, do not include the $. You can enter an integer or a decimal. If you use more than 2 decimal places, the system will round to the nearest penny-- i.e. entering 23.129 will result in a FirstPaymentAmount of 23.13.

FirstPaymentDate

date

The date the custom first payment is to be processed. This can be the current date, or any future date, but must be prior to the schedule StartDate. If a future date is used, it can be edited prior to the custom first payment being generated. After the custom first payment is actually generated the field becomes read-only. Date format: YYYY-MM-DD.

Description

string

2048 characters max.

Responses

Receipt Options

Payment Schedule Response

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

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.

201201

400400

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