/find_disbursements

post

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

A dedicated endpoint for retrieving disbursement (i.e., push) payment history. This endpoint allows clients to retrieve a list of disbursements for specific push orders (pnm_order_identifier or site_order_identifier) or the push orders associated with a specific customer (pnm_customer_identifier or site_customer_identifier). This endpoint is only for returning push payments and not regular consumer payments (use the /find_payments endpoint for regular consumer payments).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Retrieves the disbursement payment history for a specific push order or customer account.

pnm_order_identifier

string

required

The PayNearMe-created ID for the push 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_order_identifier

string

The arbitrary string that the client uses to refer to the push order.

pnm_customer_identifier

string

A PayNearMe-assigned ID for the customer.

site_customer_identifier

string

A unique, client-defined ID for the consumer.

sort

string

enum

Defaults to desc

Sort direction: 'asc' (oldest first) or 'desc' (newest first). Default: 'desc'

Allowed:

limit

integer

Used for pagination, this parameter specifies the maximum number of disbursements to return. Default value is 10.

offset

integer

Used for pagination, this parameter specifies the number of disbursement payments to skip within the response. Default value is 0.

start_date

date

Filter on or after this date (YYYY-MM-DD)

end_date

date

Filter on or before this date (YYYY-MM-DD)

Response

Language

URL

Loading…

Response

Choose an example:

application/json

201Disbursements Found