One-Time Schedules

POST /cancel_scheduled_retry

Changed on

Use the <code>pnm_schedule_identifier</code> to specify the scheduled payment retry you wish to cancel. This call works for both recurring autopay schedules and future-dated, one-time payment schedules.

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

site_identifierstring required

Identifies your client site.

timestampstring required

The Unix Epoch time of the call

versionstring required

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

signaturestring

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.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

pnm_scheduled_payment_identifierstring required

The unique, PayNearMe-created identifier for this scheduled payment.

Response

Scheduled Retry Payment Canceled

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 cancel_scheduled_retry was added

    • info

      the request property signature became optional

    2 more changes in this revision