To find a specific order, use one of the following values to search:
pnm_order_identifier
site_order_identifier
To find orders for a specific customer record, use one of the following values to search:
pnm_customer_identifier
site_customer_identifier
site_customer_email
site_customer_phone
You can also use one of the following parameters to search for orders:
site_creator_identifier
site_order_annotation
start_date
Best Practices to Ensure Fast API Response TimesBy default, PayNearMe will return all payments related to an order in response to your API call. This results in lengthy responses as your orders accrue payments in our system.
For the fastest responses, sending
return_minimal_info=true
ensures that PayNearMe will only return thepnm_order_identifier
and thepnm_customer_identifier
.If you require more information in the response than that, but do not require payment history, sending
return_no_pmts=true
in your request will eliminate payment history entirely.If you prefer to receive just the most recent payment, sending
last_pmt_only=true
in your request will limit the response to just the most recent payment.These options reduce load time and overall bandwidth and can save money on network bandwidth expenses.
Payment Method Fee ListingsThe fees specified in the
payment_methods
array represent the default convenience fees associated with each payment method. However, the actual fee charged to the consumer may vary depending on the payment channel (i.e.,site_channel
). To retrieve the most accurate fee information for each combination of payment method and payment channel, use the /get_fees endpoint.