Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
One-Time Schedules

Use the <code>pnm_scheduled_payment_identifier</code> to specify the scheduled payment you wish to cancel. Scheduled payments must be canceled prior to the <code>payment_date</code>.

post/cancel_scheduled_payment

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 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.

pnm_scheduled_payment_identifierstring required

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

Example request

{
  "pnm_scheduled_payment_identifier": "677588531597280"
}

Response

Scheduled Payment Canceled

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"
}