Trigger a disbursement of the total amount of a contractor payment before the normal cutoff time. This is only applicable for contractor payments with status of pending, speed of zero_day or instant, and disbursement method paycard or instant_pay(early access).
You cannot trigger disbursements on an unapproved contractor payment. You also cannot edit a contractor payment once a trigger has been initiated.
Once a contractor payment is triggered, the triggered field will be set to true and triggered_at will be set to the timestamp of when the disbursement was triggered.
Returns
Returns boolean indicating success status and contractor payment object if successful.
attribute | type | description |
|---|---|---|
success | boolean | Response status |
data | object | object |
errors | array | If
status type: number description: HTTP response code code type: number description: Error code (see Error codes ) |