With PayNearMe, an order is required any time money moves or is scheduled to move. Orders can be created or “staged” at the time of payment where each transaction has a unique Order ID (via the /create_order
API call) or can be created beforehand as reusable identifiers for consumers (via an SFTP bulk file upload). At a minimum, the following parameters are required to create an order:
order_amount
order_currency
site_customer_identifier
order_type
order_is_standing
Sequential Processing RequirementsWhen using the
/create_order
API, please ensure that requests sharing the samesite_customer_id
are not made in parallel. Sequential processing of these calls is required to avoid race conditions and to ensure data integrity.
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, sendingreturn_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, sendingreturn_no_pmts=true
in your request will eliminate payment history entirely.
If you prefer to receive just the most recent payment, sendinglast_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.