Update payment preferences

put

https://api.everee.com/integration/v1/workers/{id}/payment-info

Update a worker’s payout settings on behalf of the worker. You can specify whether a worker should be paid via a Pay Card rather than the default setting of ACH-based direct deposit (if available).

Path Params

string

required

The 'externalWorkerId' you assigned to the worker, or Everee's generated 'workerId' if you don't use your own IDs.

Body Params

preferredPaymentMethod

string

enum

Defaults to DIRECT_DEPOSIT

The method to use when transferring funds to a worker. If the corresponding payment account (a bank account for DIRECT_DEPOSIT, or an issued card for PAY_CARD) doesn't exist, payments to the worker will be marked as "error" and will not process until a corresponding account is created.

Allowed:

availablePaymentMethods

object

The payment methods available for the worker to select.

paySchedule

string

enum

The scheduling method to use for paying payroll. Availability of these options depends on company configuration in Everee.

Allowed:

Response

Language

Credentials

Header

Loading…

200200