One-Time Schedules
POST /find_scheduled_payments
Changed onUse either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to find the next scheduled payment for an order. These payments can include recurring payments from an autopay schedule or a future-dated, one-time payment.
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
Example request
{
"pnm_order_identifier": "82994908226"
}Response
Finds the Next Scheduled Payment
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
find_scheduled_paymentswas added - info
the request property
site_identifierwith a default value became required
4 more changes in this revision
- breaking