Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Autopay Schedules

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to skip the next scheduled payment in an autopay schedule.

post/skip_auto_pay

Request body

OR

Example request

{
  "pnm_order_identifier": "82994908226"
}

Response

Next Payment Skipped

pnm_scheduled_payment_identifierstring

Displays the scheduled payment identifier that was skipped.

scheduled_payment_datestring

Displays the date when the payment was originally scheduled in YYYY-MM-DD format.

scheduled_payment_amountstring

The amount of the scheduled payment.

scheduled_payment_currencystring

USD

scheduled_payment_statusstring

Indicates whether the autopay schedule is active, user_suspended, pending, disabled, or complete.

scheduled_payment_pricing_schedule_namestring

Specifies the name of the pricing schedule (e.g.,<code>agent_recurring</code> or <code>consumer_recurring</code>). Supported values can include site-configured pricing schedules.

scheduled_payment_payment_methodstring

A description and the last 4 digits of the account number of the payment method used in this auotpay schedule.

scheduled_payment_service_feestring

The service fee that is assessed for each payment in this autopay schedule.

scheduled_payment_originstring

Indicates whether the schedule was created in the Consumer Portal, Agent Interface, or API.

scheduled_payment_created_bystring

Indicates whether the schedule was created by the Consumer, Agent, or API.

Example response

{
  "pnm_scheduled_payment_identifier": "291154164359901",
  "scheduled_payment_date": "2024-10-31T00:00:00.000Z",
  "scheduled_payment_amount": "250",
  "scheduled_payment_currency": "USD",
  "scheduled_payment_status": "active",
  "scheduled_payment_payment_method": "Debit Card 1247",
  "scheduled_payment_service_fee": "3.99",
  "scheduled_payment_origin": "consumer",
  "scheduled_payment_created_by": "Consumer"
}