Payment Templates

A payment template is a defined configuration that can be used for the creation of payments. It can be used to do two (2) things:

1. Store payment information that can be referenced when creating a payment.

2. Create a recurring payment schedule. By creating a recurring payment schedule, you will not have to create any of the subsequent payments. Instead, the system will automatically create them based on the defined payment schedule.

About Payment Templates

This part offers extra guidance on how to effectively use payment templates for making payments.

You can optionally assign an externalId when creating a Payment Template. This field can be used to match a value from your own system. You can then reference the Payment Template by this value instead of its Guid.

You can store customer related information by creating a Customer record. You can then associate a Customer record with a given Payment Template.

How to use Payment Templates to store payment information

1. Create the Payment Template: To create a payment template, use the CreatePaymentTemplate endpoint.

   1. Make sure to set recurrencePattern = 1 (None).

2. Create Payments using the Payment Template: You are able to create payments from a Payment Template by utilizing one of two endpoints:

   1. Use the CreatePaymentFromPaymentTemplate endpoint if you want to reference the Payment Template by its system generated Guid.

   2. Use the CreatePaymentFromPaymentTemplateExternalId endpoint if you want to reference the Payment Template by an externalId that you provided.

How to use Payment Templates to create a recurring payment schedule

1. Create the Payment Template: To create a payment template, use the CreatePaymentTemplate endpoint.

   1. Set recurrencePattern to how often the recurrence should happen.

      1. Daily: Select this option if you wish the payment to occur every X days.

      2. Weekly: Select this option if you wish the payment to occur every X weeks.

      3. Monthly: Select this option if you wish the payment to occur every X months.

      4. Yearly: Select this option if you wish the payment to occur every X years.

   2. Specify the date that you wish the plan to start on using the startDate field.

   3. Specify the recurring amount to debit/credit in the amount field.

   4. The frequency field is used to indicate how often the payments should occur.

      1. For example, if you selected "Monthly" as your Recurrence Pattern and entered a "1" for Frequency, then a payment would be sent once a month every month. If you entered "2" for Frequency, then a payment would be sent once a month every two months.

   5. Set duration field to indicate how long the recurring schedule should occur.

      1. Fixed Amount: Select this option if you wish for the plan to continue until a specific amount has been reached. If you select this option, you will need to define the Duration Amount (i.e. the amount to stop at).

      2. Fixed Quantity: Select this option if you wish for the plan to continue until a specific amount has been reached. If you select this option, you will need to define the Duration Amount (i.e. the amount to stop at).

      3. Indefinite: Select this option if you wish for the plan to continue until you cancel it.

   6. Set nonBankingDayRule field to indicate how the system should treat payments when they fall on a non-banking day.

      1. Following Day: The payment will be scheduled to send the following business day.

      2. Non Business Day: The payment will be scheduled for that specific day, regardless of whether or not it is a banking day.

      3. Previous Day: The payment will be scheduled to send the previous business day.

2. That’s it! The system will automatically create payments based on the schedule that you have defined. No additional action is necessary on your part.

Related Topics

Payments

Payment Statuses (API)