Create Link Token

post

https://api.getpinwheel.com/v1/link_tokens

Create a token used to launch a Link modal.

Body Params

account_id

uuid

UUID of the payroll account.

account_name

string

length between 2 and 30

Name of the bank account.

account_number

string

length ≥ 6

Bank account number. Required if requesting direct_deposit_switch jobs.

account_type

string

enum

Bank account type, checking or savings. Required if requesting direct_deposit_switch jobs. Allowed Values: checking, savings.

Allowed:

amount

number

Amount for each direct deposit payment. Must be at exactly two decimal places.

disable_direct_deposit_splitting

boolean

Defaults to false

If set to true, user will not be given the option to choose between a full or partial direct deposit switch. Only relevant with job direct_deposit_switch. Defaults to false.

employer_id

uuid

UUID of an employer. If set, user is taken directly to Link login screen.

end_user_id

string

length between 1 and 255

User ID provided by you, to optionally associate Pinwheel users with your user model. This ID will be returned in all webhook events and all account-affiliated API responses. Leading and trailing whitespace will be stripped. Do not include PII in this identifier.

language

string

enum

Defaults to en

IETF code denoting which language to display in Link. Allowed Values: en, es.

Allowed:

org_name

string

length between 3 and 30

Organization or app name that is displayed to the user.

platform_id

uuid

UUID of a platform. If set, user is taken directly to Link login screen.

platform_type

string

enum

If included, filters results by the platform type. Platforms are either payroll or time_and_attendance. Most platforms are payroll. Payroll platforms support operations such as updating direct deposit allocation settings. Time & Attendance platforms contain data around shifts and hours worked, but do not support payroll operations. Allowed Values: payroll, time_and_attendance.

Allowed:

required_jobs

array of strings

length ≥ 1

An array of job types required to be performed on the user's payroll account. Employers and platforms that do not support ALL of these jobs will not be visible to the user. This property is required unless the account_id property is set. Allowed Values: direct_deposit_allocations, direct_deposit_switch, employment, identity, income, paystubs, shifts.

required_jobs

Allowed:

routing_number

string

length between 9 and 9

Routing number of bank. Required if requesting direct_deposit_switch jobs.

skip_intro_screen

boolean

Defaults to false

If set to true, intro screen is not shown to user.

200OK