/find_orders

post

https://api.paynearme-sandbox.com/json-api/find_orders

To find a specific order, use one of the following values to searchXXX:

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

pnm_order_identifier

string

required

The unique, PayNearMe-defined identifier for this order

site_identifier

string

required

Defaults to S2411573363

Identifies your client site.

timestamp

string

required

The Unix Epoch time of the call

version

string

required

Defaults to 3.0

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

signature

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.

site_customer_email

string

The client-provided email address of the consumer.

site_creator_identifier

string

A unique string used to identify the creator of the order.

start_date

string

The start date of a payment schedule.

end_date

string

The end date of a payment schedule.

return_minimal_info

string

If set to true, PayNearMe will only return the pnm_order_identifier and pnm_customer_identifier.

expanded_fees

string

If set to true, PayNearMe will return a detailed list of convenience fees.

site_channel

string

enum

The payment channel where this payment was created.

Allowed:

payment_type

string

enum

The type of payment method that can be accepted for this payment.

payment_amount

string

The decimal value of the payment amount.

payment_start_date

string

Enter a date in YYYY-MM-DD format to filter the list of payments that are returned in the order object response. For example, entering 2012-07-01 returns all payments that occurred on or after 2012-07-01 00:00:00 -0700.

payment_end_date

string

payment_count_limit

string

Enforces a limit to the number of payments that are returned in the order object response. For example, entering 2 limits the number of payments listed in the order to the 2 most recent payments. Use this parameter in conjunction with the sort_payments parameter to sort the listed payments by oldest (i.e.,asc) or the most recent (i.e., desc). By default, all payments are returned, which can slow down response time.

payment_methods_limit

integer

Maximum number of payment processor accounts (PPAs) to return per payment method. Use 0 for no PPAs. Default: unlimited.

sort_payments

string

enum

Sorts the payments returned in the order object response from oldest to most recent (i.e., asc) or from the most recent payments to oldest (i.e., desc). The default value for this parameter is asc.

Allowed:

last_pmt_only

string

Submit as true to only return the most recent payment made for the order in the order object response.

return_no_pmts

string

Submit as true if you don't want payment records returned in the order object response.

Response

201Order(s) Found