One-Time Schedules
POST /cancel_scheduled_retry
Changed onUse 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 URLhttps://api.paynearme-sandbox.com/json-api
- Auth
- OAuth 2Client credentialsToken URLhttps://login.paynearme.com/oauth/token
- or API key in query parameter signature
Request body
Response
Scheduled Retry Payment Canceled
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_retrywas added - info
the request property
signaturebecame optional
2 more changes in this revision
- breaking