v4

latestOpenAPI 3.0.02026-07-314441026.8 MB
Payments

Hold a payment

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

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").