---
title: "POST /schedule_payment"
method: POST
path: "/schedule_payment"
tags: ["One-Time Schedules"]
---

# POST /schedule_payment

`POST /schedule_payment`

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>

## Request body

- union — Schedule a future-dated, one-time payment.
  - object
    - `site_identifier` string, required — Identifies your client site.
    - `timestamp` string, required — The Unix Epoch time of the call
    - `version` string, required — The version of the API. This version must match the version associated with your API key pair.
    - `signature` 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.
    - `payment_method_identifier` string, required — The unique, PayNearMe-created identifier for this payment method.
    - `payment_amount` string, required — The payment amount you are making towards the order.
    - `payment_currency` string, required — USD
    - `payment_date` string, required — The date when you want to schedule a payment in <i>MM/DD/YYYY</i> format. This date must be at least one day in the future.
    - `payment_authorization` 'WEB' | 'TEL', required — The method by which the consumer authorized the scheduled payment. Supported options include the following:<ul><li><code>WEB</code></li><li><code>TEL</code></li></ul>
    - `notification_contact` string, required — The email or mobile number that PayNearMe will contact to confirm completion of the payment.
    - `pricing_schedule_name` string — Specifies the name of the pricing schedule (e.g.,<code>agent</code>, <code>agent_recurring</code>, <code>consumer</code>, <code>consumer_recurring</code>,<code>consumer_ivr</code>). Supported values can include site-configured pricing schedules.
    - `pnm_order_identifier` string, required — The unique, PayNearMe-defined identifier for this order
  - object
    - `site_identifier` string, required — Identifies your client site.
    - `timestamp` string, required — The Unix Epoch time of the call
    - `version` string, required — The version of the API. This version must match the version associated with your API key pair.
    - `signature` 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.
    - `payment_method_identifier` string, required — The unique, PayNearMe-created identifier for this payment method.
    - `payment_amount` string, required — The payment amount you are making towards the order.
    - `payment_currency` string, required — USD
    - `payment_date` string, required — The date when you want to schedule a payment in <i>MM/DD/YYYY</i> format. This date must be at least one day in the future.
    - `payment_authorization` 'WEB' | 'TEL', required — The method by which the consumer authorized the scheduled payment. Supported options include the following:<ul><li><code>WEB</code></li><li><code>TEL</code></li></ul>
    - `notification_contact` string, required — The email or mobile number that PayNearMe will contact to confirm completion of the payment.
    - `pricing_schedule_name` string — Specifies the name of the pricing schedule (e.g.,<code>agent</code>, <code>agent_recurring</code>, <code>consumer</code>, <code>consumer_recurring</code>,<code>consumer_ivr</code>). Supported values can include site-configured pricing schedules.
    - `site_order_identifier` string, required — An arbitrary string that the client uses to refer to an order

## Response `201`

Scheduled Payment Created

- ScheduledPayment — The Scheduled Payments object contains the details of future-dated, one-time payments.
  - `pnm_scheduled_payment_identifier` string — The unique, PayNearMe-provided ID of this scheduled payment.
  - `scheduled_payment_date` string, date-time — The date and time when the consumer scheduled the payment.
  - `scheduled_payment_amount` number — The total amount of the scheduled payment including convenience fees.
  - `scheduled_payment_currency` string — USD
  - `scheduled_payment_status` 'active' | 'user_suspended' | 'pending' | 'complete' | 'disabled' — The status of the payment.
  - `scheduled_payment_pricing_schedule_name` string — 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_method` string — A short description of the payment method that will be used for this scheduled payment.
  - `scheduled_payment_service_fee` string — 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_by` string — The name or ID of the creator of this scheduled payment.
  - `scheduled_payment_type` string — Indicates whether this is a <code>recurring</code> autopay payment or a <code>one-time</code> scheduled payment.
  - `scheduled_payment_retry_pending` string — Indicates whether or not there is a pending retry scheduled for this transaction.

---

[API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/versions/44cba4f8b80f/schema)