---
title: "Hold a payment"
method: POST
path: "/payments/{payment}/hold"
tags: ["Payments"]
---

# Hold a payment

`POST /payments/{payment}/hold`

Place a payment on hold.

Any payment can be held regardless of its status or destination. What the hold means depends
on timing: holding a payment before it has been processed prevents it from being submitted to
the banking network. Holding a funding payment after it has settled blocks all downstream
payments (employee, CRA, RQ) from being processed, but does not reverse the settled payment.

## Path parameters

- `payment` string, required

## Request body

- object

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"payment"`).
  - `data` Payment
    - `payroll` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"payroll"`).
    - `remittance_account` unknown
    - `destination` 'bill_pay' | 'cra' | 'employee' | 'internal' | 'no_op' | 'payroll_float' | 'rq' — Where the payment is destined. `payroll_float` is the funding debit from the employer's bank account. `employee` is a credit to an employee or contractor. `cra` and `rq` are remittances to the Canada Revenue Agency (CRA) and Revenu Québec (RQ), respectively. Where the payment is destined. For example, `employee` for payments to employees, `cra` for remittances to CRA, `payroll_float` for business funding.
    - `method` 'direct_deposit' | 'manual' | 'pad' | 'wire' — How the payment will be processed. `pad` (Pre-Authorized Debit) is used for employer funding. `direct_deposit` is used for employee credits. `manual` indicates the payment is handled outside of Nmbr. How the payment will be processed. For example, `direct_deposit` or `pad`.
    - `amount` number — The dollar amount of the payment.
    - `status` 'canceled' | 'failed' | 'overdue' | 'paid' | 'pending' | 'processing' — The current processing status of the payment. Payments begin as `pending`, move to `processing` when submitted to the banking network, and settle as `paid` or `failed`. Held payments that pass their processing date become `overdue`.
    - `process_at` string, date, nullable — The date on which Nmbr will submit the payment to the banking network for processing.
    - `expected_at` string, date — The date on which the payment is expected to arrive at its destination.
    - `is_impacted_by_weekend_or_holiday` boolean — Whether the payment dates have been adjusted due to a weekend or bank holiday. Whether the payment dates have been adjusted due to a weekend or bank holiday.
    - `is_held` boolean — Whether the payment is currently held. A held payment will not be submitted for processing until it is released.
    - `held_at` string, dateTime, nullable — The timestamp when the payment was placed on hold. `null` if the payment is not held. The timestamp when the payment was placed on hold. `null` if the payment is not held.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)