/authorize_cash_payment

post

https://api.paynearme-sandbox.com/json-api/authorize_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.

Starts a cash payment toward an order: PayNearMe authorizes it and returns the payment. Confirm it with confirm_cash_payment once the cash is collected, or set confirm_payment to true to confirm it in the same call.

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

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.

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.

confirm_payment

string

Set to true to confirm the payment in the same call.

site_payment_identifier

string

Your identifier for this payment.

transaction_num

string

The transaction number from your register or kiosk.

transaction_date

string

The date and time of the transaction at your location.

message_identifier

string

Your identifier for this message, saved with the payment.

Responses

200Payment Authorized