Trigger Disbursement

Trigger a disbursement of the total amount of a contractor payment. This is only applicable for contractor payments with status of pending, speed of zero_day, and disbursement method paycard (early access).

You cannot trigger disbursements on an unapproved contractor payment. You also cannot edit a contractor payment once a trigger has been initiated.

Returns

Returns boolean indicating success status and contractor payment object if successful.

attributetypedescription
successbooleanResponse status
dataobjectContractor Payment object
errorsarrayIf success is false, errors contains a list of error objects.


Show child attributes message
type: string
description: Error message

status
type: number
description: HTTP response code

code
type: number
description: Error code (see Error codes )
Language
Credentials
Header
Click Try It! to start a request and see the response here!