Create Site

post

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

Create a Link token that includes a site redirect.

Body Params

account_id

uuid

UUID of the payroll account.

allocation

object

Allocation specified for the link token.

card

object

Card details needed to attempt a card switch.

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:

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:

redirect_url

uri

required

length between 1 and 65536

A URL to redirect after the job has been executed.

required_jobs

array of strings

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.

required_jobs

skip_intro_screen

boolean

Defaults to false

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

ttl

integer

900 to 1209600

TTL in seconds before site URL expires. Defaults to minimum of 900 (15 minutes). Max is 1209600 (14 days).

Headers

Pinwheel-Version

string

enum

required

Defaults to 2022-09-09

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Allowed:

Response

200OK