[Sandbox] Complete payment

Settle a single payment, which moves from processing to paid. Works on the employer debit and on employee and contractor credits. Sandbox-only. The payment must have a status of processing.

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

Only supported in Sandbox. Settles a single payment, which moves from processing to paid. Works on the employer debit and on employee and contractor credits.

The payment must have a status of processing. Right after [Sandbox] Start processing, a payroll's payments are draft for a few seconds, so wait until they're processing before calling this endpoint. Find a payroll's payments with List payments.

We recommend setting the payroll's simulation_mode to manual, so the payroll doesn't advance on its own while you test. See Testing Payments in Sandbox.

Path Params
string
required

ID of the payment.

Responses

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