/void_cash_payment

post

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

NOTE: Available only on sites PayNearMe has set up to accept cash directly, such as a kiosk or a cash cage, with registered retailer locations. Other sites get invalid retailer.

Voids a cash payment that has been authorized but not confirmed. The amount and location must match the authorization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Voids a cash payment that has been authorized but not confirmed. The amount and location must match the authorization.

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 payment identifier returned by authorize_cash_payment.

payment_amount

string

required

The amount of cash presented.

payment_currency

string

required

Defaults to USD

The currency of the payment amount.

retailer_location_identifier

string

required

The identifier of the retailer location taking the cash. It must be registered to your site and match the location used to authorize the payment.

message_identifier

string

Your identifier for this message, saved with the payment.

proxy_site_identifier

string

The site identifier of the merchant you're acting for, when calling as a proxy site.

Responses

200Payment Voided