/schedule_auto_pay

Use either the pnm_order_identifier or the site_order_identifier to find the order for which you want to create a schedule of recurring transactions, or an autopay schedule. Only one autopay schedule can be defined for an order. Autopay schedules can be configured for the following frequencies:

• weekly - Payments are made every week on the same day as the auto_pay_start_date (e.g., every Wednesday)
• bi-weekly - Payments are made every other week on the same day as the auto_pay_start_date (e.g., every other Wednesday)
• monthly - Payments are made each month on the same date as the auto_pay_start_date (e.g., the 20th of every month)
• twice_monthly - Payments are made twice a month on the dates specified in the auto_pay_multi_first and auto_pay_multi_last parameters, which are required for this autopay frequency (e.g., the 15th and 28th of every month)
• end_of_month - Payments are made on the last day of every month (e.g., the last day of every month)
• due_date_monthly - Payments are made on the due date provided by the client in their Consumer Account File

🧪 How to Test

Since only one autopay schedule can be defined per order, you will not be able to use the example order that auto-populates in this call. Rather, use the /create_order call to create a new order and then use that new order's pnm_order_identifier to create a payment method using the /create_payment_method endpoint. Next, take the pnm_order_identifier and the pnm_payment_method and plug them into the relevant fields of this call. From there, you can build out the type of autopay schedule you want to create, click Sign It!, and then Try It!. Remember to also update the auto_pay_start_date (unless you're testing this before October 25, 2023 😉)