API Reference

/schedule_payment

post
https://api.paynearme-sandbox.com/json-api/schedule_payment

Use either the pnm_order_identifier or the site_order_identifier to find the order and then include the following required parameters to make the payment:

  • payment_amount
  • payment_currency
  • payment_method_identifier
  • payment_date
  • payment_authorization
  • pricing_schedule_name

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schedules a future-dated, one-time payment using an existing payment method.

string
required

The unique, PayNearMe-defined identifier for this order

string
required
Defaults to S2411573363

Identifies your client site.

string
required

The Unix Epoch time of the call

string
required
Defaults to 3.0

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

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

string
required
Defaults to ff603e367b0ba

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

string
required
Defaults to 250

The payment amount you are making towards the order.

string
required
Defaults to USD

USD

string
required
Defaults to 10/25/2023

The date when you want to schedule a payment in MM/DD/YYYY format. This date must be at least one day in the future.

string
enum
required
Defaults to WEB

The method by which the consumer authorized the scheduled payment. Supported options include the following:

  • WEB
  • TEL

Allowed:
string
required
Defaults to 214-555-5897

The email or mobile number that PayNearMe will contact to confirm completion of the payment.

string

Specifies the name of the pricing schedule (e.g.,agent, agent_recurring, consumer, consumer_recurring,consumer_ivr). Supported values can include site-configured pricing schedules.

Response

Updated 28 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 28 days ago