Payments

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.

post/payments/{payment}/hold

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

paymentstring required

Request body

object required

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("payment").

Changes

    • warning

      added the new on_mof enum value to the / response property for the response status