One-Time Schedules

POST /schedule_payment

Changed on

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

  • Base URL
    https://api.paynearme-sandbox.com/json-api
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://login.paynearme.com/oauth/token
    • or API key in query parameter signature

Request body

OR

Example request

{
  "pnm_order_identifier": "84338052224"
}

Response

Scheduled Payment Created

OR

Example response

{
  "status": "ok",
  "scheduled_payment": {
    "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"
  }
}

Changes

    • breaking

      removed the success response with the status

    • info

      api operation id schedule_payment was added

    • info

      the request property site_identifier with a default value became required

    4 more changes in this revision