---
title: "POST /send_notification"
method: POST
path: "/send_notification"
tags: ["Notifications"]
---

# POST /send_notification

`POST /send_notification`

## Request

- Base URL: `https://api.paynearme-sandbox.com/json-api`
- URL: `https://api.paynearme-sandbox.com/json-api/send_notification`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://login.paynearme.com/oauth/token`
  - API key in query parameter `signature`

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

## Request body

- union: Creates and sends an Email or SMS message about the order, payment, or disbursement
  - object
    - `site_identifier` string, required: Identifies your client site.
    - `timestamp` string, required: The Unix Epoch time of the call
    - `version` string, required: 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.
    - `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 <code>true</code> to send the consumer the order confirmation email or SMS message.
    - `paid_confirmation` string: Submit as <code>true</code> 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 <code>true</code> 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.
    - `pnm_order_identifier` string, required: The unique, PayNearMe-defined identifier for this order
  - object
    - `site_identifier` string, required: Identifies your client site.
    - `timestamp` string, required: The Unix Epoch time of the call
    - `version` string, required: 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.
    - `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 <code>true</code> to send the consumer the order confirmation email or SMS message.
    - `paid_confirmation` string: Submit as <code>true</code> 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 <code>true</code> 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.
    - `site_order_identifier` string, required: An arbitrary string that the client uses to refer to an order

## Response `200`

Message Sent

- SendNotificationResponse
  - `status` string: Provides the status of the request.
  - `disbursement_query_url` string: Provides the URL where the consumer can add his/her debit card, bank acount, or mobile wallet information where he/she wants to receive the disbursement funds.
  - `disbursement_status` 'queried_user' | 'created' | 'complete': Indicates the status fo the disbursement.

## Other responses

- `401`: OAuth 2.0 requests only. The `Authorization` header has no Bearer token, the access token is invalid, expired, or issued for a different site, or the `site_identifier` does not match any site. The response does not say which. If the request is rejected before it reaches PayNearMe, the body may not be JSON, so detect this error by the HTTP status. HMAC-signed requests never receive this status.

## Changes

- **2026-11-03** `907541f733a3`: 1 breaking, 6 info
  - removed the success response with the status `201`
  - api operation id `send_notification` was added
  - the request property `site_identifier` with a default value became required
  - the request property `timestamp` with a default value became required
  - …3 more

[Operation history](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/changes/send_notification/post.md)

---

[API](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0.md) - [All operations](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/llms.txt) - [OpenAPI document](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/revisions/907541f733a3?raw)
