Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
One-Time Schedules

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to find the order and then include the following required parameters to make the payment:<ul><li><code>payment_amount</code></li><li><code>payment_currency</code></li><li><code>payment_method_identifier</code></li><li><code>payment_date</code></li><li><code>payment_authorization</code></li><li><code>pricing_schedule_name</code></li></ul>

post/schedule_payment

Request body

OR

Example request

{
  "pnm_order_identifier": "84338052224"
}

Response

Scheduled Payment Created

pnm_scheduled_payment_identifierstring

The unique, PayNearMe-provided ID of this scheduled payment.

scheduled_payment_datestring date-time

The date and time when the consumer scheduled the payment.

scheduled_payment_amountnumber

The total amount of the scheduled payment including convenience fees.

scheduled_payment_currencystring

USD

scheduled_payment_status'active' | 'user_suspended' | 'pending' | 'complete' | 'disabled'

The status of the payment.

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 short description of the payment method that will be used for this scheduled payment.

scheduled_payment_service_feestring

The service fee that will be charged for this scheduled payment.

scheduled_payment_origin'consumer' | 'merchant' | 'import' | 'pnm'

The origin of the scheduled payment. Supported options include the folloing:<ul><li><code>consumer</code></li><li><code>merchant</code></li><li><code>import</code></li><li><code>pnm</code></li></ul>

scheduled_payment_created_bystring

The name or ID of the creator of this scheduled payment.

scheduled_payment_typestring

Indicates whether this is a <code>recurring</code> autopay payment or a <code>one-time</code> scheduled payment.

scheduled_payment_retry_pendingstring

Indicates whether or not there is a pending retry scheduled for this transaction.

Example response

{
  "pnm_scheduled_payment_identifier": "466410151625253",
  "scheduled_payment_date": "2023-10-19T00:00:00Z",
  "scheduled_payment_amount": 250,
  "scheduled_payment_currency": "USD",
  "scheduled_payment_status": "active",
  "scheduled_payment_payment_method": "Bank of Glen Ullin 6816",
  "scheduled_payment_created_by": "Merchant",
  "scheduled_payment_type": "recurring",
  "scheduled_payment_retry_pending": "false"
}