/annotate_payment

post

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

NOTE: Available only on sites set up with site user types (for example, for disbursements to push users). On other sites the API returns Unrecognized API Call.

Records how a payment was delivered to a user: whether it was delivered, when, and how much. Returns the user and the updated payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

site_user_identifier

string

required

The unique, client-defined ID of the person receiving the disbursement funds.

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

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.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

pnm_payment_identifier

string

required

The PayNearMe identifier of the payment to annotate.

delivery_disposition

string

enum

required

Whether the payment reached the user.

Allowed:

delivery_at

string

required

When the payment was delivered, for example 2026-11-06 14:30.

delivery_amount

string

required

The amount delivered.

delivery_currency

string

required

Defaults to USD

The currency of the payment amount.

delivery_details

string

Notes about the delivery.

Responses

200Payment Annotated