API Reference

/schedule_auto_pay

post
https://api.paynearme-sandbox.com/json-api/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) or, if configured, a preferred week and day of the month using the auto_pay_first_nth_weekday (e.g., the last Friday 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). If configured, payments can also be made on preferred days and weeks of the month using the auto_pay_first_nth_weekday and auto_pay_second_nth_weekday parameters (e.g., first and last Fridays of the month).
  • end_of_month - Payments are made on the last day of every month or the preferred weekday in the last week of every month using the auto_pay_first_nth_weekday parameter. (e.g., last friday of the month)
  • due_date_monthly - Payments are made on the due date provided by the client in their Consumer Account File

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Creates an autopay schedule using an existing payment method.

string
required

The unique, PayNearMe-defined identifier for this order

string
required
Defaults to S2411573363

Identifies your client site.

string
required

The Unix Epoch time of the call

string
required
Defaults to 3.0

The version of the API. This version must match the version associated with your API key pair.

string
required

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

string
enum
required

The frequency of the autopay. Supported options include the following:

  • weekly
  • biweekly
  • monthly
  • twice_monthly
  • end_of_month
  • due_date_monthly

Allowed:
string
required

The amount for each scheduled autopay payment without convenience fees. To use the amount due for each billing cycle, submit auto_pay_use_amt_due=true.

string
required
Defaults to USD

USD

string
required
Defaults to b705067a8fdd4

The unique, PayNearMe-created identifier for the payment method that will be used in this autopay schedule.

string
enum
required

The duration of the autopay schedule. Supported options include the following:

  • indefinite
  • number_of_recurrences
  • end_date
  • paid_in_full

Allowed:
string
required

The start date of the auto pay schedule in MM/DD/YYYY format. This date must be at least one day in the future.

string

The end date of the autopay in MM/DD/YYYY format. This parameter is required if auto_pay_duration_type=end_date.

string

The total number of payments to be made when auto_pay_duration_type=number_of_recurrences.

string

The first payment day of the month for twice monthly autopay schedules (i.e., auto_pay_frequency=twice_monthly).

string

The second payment day of the month for twice monthly autopay schedules (i.e., auto_pay_frequency=twice_monthly).

string
enum

Indicates whether to schedule recurring payments on a fixed calendar date (e.g., the 15th of every month) using auto_pay_schedule_mode=date_ordinal or a preferred day and week of the month (e.g., "the second Tuesday of every month") using auto_pay_schedule_mode=nth_weekday. Your site must be configured for the Day-of-Week scheduling option. Consult your PayNearMe Technical Account Manager for more information.

Allowed:
string
enum

The preferred day and week for the first or only autopay schedule using Day-of-Week scheduling (e.g., first Tuesday of the month). This parameter is required if auto_pay_schedule_mode=nth_weekday and auto_pay_frequency is monthly, twice_monthly, or end_of_month.

string
enum

The preferred day and week for the second payment in twice_monthly autopay schedules using Day-of-Week scheduling (e.g., first Tuesday of the month). This parameter is required if auto_pay_schedule_mode=nth_weekday and auto_pay_frequency=twice_monthly.

string
enum
required
Defaults to WEB

The method by which the consumer authorized the scheduled payment. Supported options include the following:

  • WEB
  • PPD
  • TEL

Allowed:
string

The date when the consumer authorized the autopay schedule in MM/DD/YYYY format. This parameter is required if auto_pay_authorization=PPD.

string
required
Defaults to 214-555-5897

The email or mobile number that PayNearMe will contact to confirm completion of the autopay payment.

string
enum

Specifies the type of the pricing schedule to use for this autopay schedule.

Allowed:
Response

Updated 28 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 28 days ago