---
title: "POST /suspend_order"
method: POST
path: "/suspend_order"
tags: ["Orders"]
---

# POST /suspend_order

`POST /suspend_order`

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to find the active order you want to suspend immediately. Consumers cannot make payments against suspended orders.

## Request body

- union — Suspend an order so that consumers cannot make payments against it.
  - 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, 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.
    - `reason` string — A short description why the order is being suspended.
    - `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, 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.
    - `reason` string — A short description why the order is being suspended.
    - `site_order_identifier` string, required — An arbitrary string that the client uses to refer to an order

## Response `201`

Order Suspended

- SuspendOrderResponse — Provides the results of an order suspension request.
  - `order_suspended` string — Displays the order that was suspended.

---

[API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/revisions/44cba4f8b80f/schema)