Trigger Disbursement

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.

attributetypedescription
successbooleanResponse status
dataobject

Contractor 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 )

Body Params
string
required

Company ID of employer

string
required

ID of Contractor Payment that you wish to disburse the amounts for

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json