/send_notification

post

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

Create and send an order confirmation, payment confirmation, or Disbursement User Query email or SMS message to the consumer.

Body Params

Creates and sends a new email or SMS message about the order, payment, or disbursement

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 email addresses where you are sending the email. Use commas to separate email addresses when sending the message to multiple recipients.

site_customer_phone

string

The text of the SMS message. This parameter does not support HTML or special characters like emojis.

order_confirmation

string

Submit as true to send the consumer the order confirmation email or SMS message.

paid_confirmation

string

Submit as true to send the consumer the payment confirmation email or SMS message. This call will only work for orders that have been paid.

user_disbursement_query

string

Submit as true to send the consumer the disbursement user query email or SMS message. This message instructs disbursement recipients on how to input their debit card, bank account, or mobile wallet information where they'll receive their funds.

Response

Language

URL

Response

Choose an example:

application/json

201Message Sent