To find a specific order, use one of the following values to searchXXX:
pnm_order_identifiersite_order_identifier
To find orders for a specific customer record, use one of the following values to search:
pnm_customer_identifiersite_customer_identifiersite_customer_emailsite_customer_phone
You can also use one of the following parameters to search for orders:
site_creator_identifiersite_order_annotationstart_date
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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. The following options reduce load times and bandwidth usage, helping to lower network costs.
Limiting Payment ListingsFor the fastest responses, sending
return_minimal_info=trueensures that PayNearMe will only return thepnm_order_identifierand thepnm_customer_identifier.If you require more information in the response than that, but do not require payment history, sending
return_no_pmts=truein your request will eliminate payment history entirely.If you prefer to receive just the most recent payment, sending
last_pmt_only=truein your request will limit the response to just the most recent payment.
Limiting Payment Method ListingsUse
payment_methods_limitto limit the number of stored payment methods (accounts) returned within each payment method type (i.e.,paypal,venmo,debit,gpay,ach,cash_app) in the response. This is useful for orders with many saved payment methods where returning all accounts would impact performance.
Payment Method Fee ListingsThe fees specified in the
payment_methodsarray 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.