API Reference

/simulate_payment

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

Use either the pnm_order_identifier or the site_order_identifier to find the order and then include the following required parameters to simulate a cash payment at a specified retailer:

  • payment_amount
  • payment_currency
  • payment_date
  • retailer_identifer

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

Simulates a cash payment for the specified order.

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 100

The payment amount you are making towards the order.

string
required
Defaults to USD

USD

string
required
Defaults to 11/10/2023

The date of the payment in MM/DD/YYYY format.

string
enum
required

The retailer where you want to simulate this cash payment.

Response

Updated 6 days ago

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

Updated 6 days ago