Skip to navigation

Add off-cycle payment

Adds a one-off payment to a contract outside its regular payment cycle, such as a bonus, a reimbursement or a correction that the contractor should receive on top of the scheduled amount. Set is_auto_approved to skip the manual approval step. Use GET /contracts/{contract_id}/off-cycle-payments/{off_cycle_payment_id} to follow the payment afterwards.

Token scopes: off-cycle-payments:write

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

The unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.

Request

Details of the off-cycle payment to be created.

dataobjectOptional

The off-cycle payment data to submit.

Response

The off-cycle payment was successfully created.

dataobject

Details of the newly created off-cycle payment.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error