Returns details about a user. This endpoint requires a currently authenticated user with a valid access token. Use of this endpoint does not require a Unique User ID.
Full description of a user.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "scopes": [
- "user:read"
], - "user_id": "123e4567-e89b-12d3-a456-426614174000",
- "full_name": "George Costanza",
- "status": {
- "code": "ACTIVE",
- "description": "The user is fully active with all features enabled."
}, - "earnings_balance": {
- "currency": "USD",
- "amount": 7250
}, - "negative_balance": {
- "currency": "USD",
- "amount": 7250
}, - "remainder_setup_required": true,
- "negative_balance_payoff_enrollment_required": true,
- "transfer_fees": {
- "within_30_minutes_fee": {
- "currency": "USD",
- "amount": 7250
}, - "next_business_day_fee": {
- "currency": "USD",
- "amount": 7250
}
}, - "employers": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
Returns details about a user via their Unique User ID.
Full description of a user.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "scopes": [
- "user:read"
], - "user_id": "123e4567-e89b-12d3-a456-426614174000",
- "full_name": "George Costanza",
- "status": {
- "code": "ACTIVE",
- "description": "The user is fully active with all features enabled."
}, - "earnings_balance": {
- "currency": "USD",
- "amount": 7250
}, - "negative_balance": {
- "currency": "USD",
- "amount": 7250
}, - "remainder_setup_required": true,
- "negative_balance_payoff_enrollment_required": true,
- "transfer_fees": {
- "within_30_minutes_fee": {
- "currency": "USD",
- "amount": 7250
}, - "next_business_day_fee": {
- "currency": "USD",
- "amount": 7250
}
}, - "employers": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
Get all transfer accounts for a user.
Returns the details of the user's transfer accounts.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
[- {
- "id": "10b3d654-c6ed-40d8-9177-434942d04114",
- "type": "BANK_ACCOUNT",
- "status": {
- "code": "ADDED",
- "description": "The account is on file but has not been used as a destination."
}, - "data": {
- "first_name": "Jane",
- "last_name": "Doe",
- "routing_number": "XXXXX4321",
- "account_number": "XXXXXX4321",
- "is_checking": true,
- "is_rtp": true,
- "schedule_options": [
- "WITHIN_30_MINUTES",
- "NEXT_BUSINESS_DAY"
]
}
}, - {
- "id": "6d6f8941-fea5-42b9-a15c-f7bab24ceab4",
- "type": "DEBIT_CARD",
- "status": {
- "code": "ADDED",
- "description": "The account is on file but has not been used as a destination."
}, - "data": {
- "first_name": "George",
- "last_name": "Costanza",
- "last_four": "9921",
- "issuer": "414543",
- "expiration_month": "12",
- "expiration_year": "2025",
- "schedule_options": [
- "WITHIN_30_MINUTES"
]
}
}
]
Add a transfer account for a user. A user can have multiple transfer accounts.
An account to use as the transfer account for the user.
Return transfer account that was created.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "transfer_account_type": "BANK_ACCOUNT",
- "transfer_account": {
- "first_name": "George",
- "last_name": "Costanza",
- "routing_number": "123454321",
- "account_number": "0123454321"
}
}
{- "id": "10b3d654-c6ed-40d8-9177-434942d04114",
- "type": "BANK_ACCOUNT",
- "status": {
- "code": "ADDED",
- "description": "The account is on file but has not been used as a destination."
}, - "data": {
- "first_name": "George",
- "last_name": "Costanza",
- "routing_number": "XXXXX4321",
- "account_number": "XXXXXX4321",
- "is_checking": false,
- "is_rtp": false,
- "schedule_options": [
- "WITHIN_30_MINUTES",
- "NEXT_BUSINESS_DAY"
]
}
}
Get a transfer account by ID.
Returns the details of the user's transfer account
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "id": "10b3d654-c6ed-40d8-9177-434942d04114",
- "type": "BANK_ACCOUNT",
- "status": {
- "code": "ADDED",
- "description": "The account is on file but has not been used as a destination."
}, - "data": {
- "first_name": "George",
- "last_name": "Costanza",
- "routing_number": "XXXXX4321",
- "account_number": "XXXXXX4321",
- "is_checking": false,
- "is_rtp": false,
- "schedule_options": [
- "WITHIN_30_MINUTES",
- "NEXT_BUSINESS_DAY"
]
}
}
Get the remainder account for a user.
Returns the details of the user's remainder account.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "first_name": "George",
- "last_name": "Costanza",
- "routing_number": "XXXXX4321",
- "account_number": "XXXXXX4321",
- "is_checking": false,
- "is_rtp": false,
- "schedule_options": [
- "WITHIN_30_MINUTES",
- "NEXT_BUSINESS_DAY"
]
}
Create or update the remainder account for a user. There can only be one configured remainder account a time.
A bank account to use as the remainder account for the user.
Returns updated remainder bank account.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "first_name": "George",
- "last_name": "Costanza",
- "routing_number": "123454321",
- "account_number": "0123454321"
}
{- "first_name": "George",
- "last_name": "Costanza",
- "routing_number": "XXXXX4321",
- "account_number": "XXXXXX4321",
- "is_checking": false,
- "is_rtp": false,
- "schedule_options": [
- "WITHIN_30_MINUTES",
- "NEXT_BUSINESS_DAY"
]
}
Look up the status of a transfer.
Reports the status of the requested transfer.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "id": "26e8345f-f181-4c0b-bd97-74823dd91668",
- "status": {
- "code": "PENDING",
- "error_code": "CARD_EXPIRED",
- "description": "The request has been successfully submitted and is being processed"
}, - "schedule": "NEXT_BUSINESS_DAY",
- "transfer_account_id": "12345",
- "amount": {
- "currency": "USD",
- "amount": 7250
}, - "fees_charged": {
- "currency": "USD",
- "amount": 7250
}, - "reason": "TRANSFER",
- "date_submitted": "2021-04-21T21:30:58.051Z",
- "date_resolved": "2021-04-21T21:30:58.051Z",
- "paycheck_ids": [
- "123e4567-e89b-12d3-a456-426614174000"
]
}
Get the 25 most recent transfers (user initiated advances and remainder payments) for a user.
Returns the details of the user's transfers.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
[- {
- "id": "901e4567-e89b-12d3-a456-426614174000",
- "status": {
- "code": "PENDING",
- "description": "The request has been successfully submitted and is being processed"
}, - "schedule": "WITHIN_30_MINUTES",
- "transfer_account_id": "234e4567-e89b-12d3-a456-426614174000",
- "amount": {
- "currency": "USD",
- "amount": 2000
}, - "fees_charged": {
- "currency": "USD",
- "amount": 299
}, - "reason": "TRANSFER",
- "date_submitted": "2021-04-21T21:30:58.051Z",
- "date_resolved": "2021-04-21T21:30:58.051Z",
- "paycheck_ids": [
- "123e4567-e89b-12d3-a456-426614174000",
- "678e4567-e89b-12d3-a456-426614174000"
]
}, - {
- "id": "901e4567-e89b-12d3-a456-426614174000",
- "status": {
- "code": "SUCCESSFUL",
- "description": "The request has been successfully completed"
}, - "schedule": "NEXT_BUSINESS_DAY",
- "transfer_account_id": "234e4567-e89b-12d3-a456-426614174000",
- "amount": {
- "currency": "USD",
- "amount": 135000
}, - "fees_charged": {
- "currency": "USD",
- "amount": 0
}, - "reason": "PAYCHECK_REMAINDER",
- "date_submitted": "2021-04-21T21:30:58.051Z",
- "date_resolved": "2021-04-19T05:30:58.051Z",
- "paycheck_ids": [
- "123e4567-e89b-12d3-a456-426614174000"
]
}
]
Request a transfer from the earnings balance. A user Remainder Account is a prerequisite for this request. Use the /users/:user_id/remainder_account endpoint to create one for the user if necessary.
Reports the status of the transfer
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "transfer_account_id": "123e4567-e89b-12d3-a456-426614174000",
- "transfer_id": "MTIzNDUxMjM0NTEyMzQ1MTIzNDU",
- "amount": {
- "currency": "USD",
- "amount": 7250
}, - "schedule": "WITHIN_30_MINUTES"
}
{- "id": "26e8345f-f181-4c0b-bd97-74823dd91668",
- "status": {
- "code": "PENDING",
- "error_code": "CARD_EXPIRED",
- "description": "The request has been successfully submitted and is being processed"
}, - "schedule": "NEXT_BUSINESS_DAY",
- "transfer_account_id": "12345",
- "amount": {
- "currency": "USD",
- "amount": 7250
}, - "fees_charged": {
- "currency": "USD",
- "amount": 7250
}, - "reason": "TRANSFER",
- "date_submitted": "2021-04-21T21:30:58.051Z",
- "date_resolved": "2021-04-21T21:30:58.051Z",
- "paycheck_ids": [
- "123e4567-e89b-12d3-a456-426614174000"
]
}
View details on user's balance and current pay period
User's balance details.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "last_shift_reported_at": "2021-04-21T21:30:58.051Z",
- "detailed_user_status": "active"
}
Get 25 most recent paychecks, including paychecks that have not yet been deposited.
Returns the details of the user's paychecks.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Client requires additional permissions or scopes.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "data": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "status": {
- "code": "PROCESSING",
- "description": "The PROCESSING status indicates a paycheck is in processing, and may not contribute to user's balance, based on employer configuration."
}, - "employer_name": "Paddy's Pub",
- "total_balance": {
- "currency": "USD",
- "amount": 7250
}, - "total_earnings": {
- "currency": "USD",
- "amount": 7250
}, - "total_withholdings": {
- "currency": "USD",
- "amount": 7250
}, - "total_transferred": {
- "currency": "USD",
- "amount": 7250
}, - "total_fees_paid": {
- "currency": "USD",
- "amount": 7250
}, - "remainder_account_id": "123e4567-e89b-12d3-a456-426614174000",
- "paycheck_scheduled_at": "2021-04-21T21:30:58.051Z",
- "payday_at": "2021-04-21T21:30:58.051Z",
- "pay_period_starts_at": "2021-04-21T21:30:58.051Z",
- "pay_period_ends_at": "2021-04-21T21:30:58.051Z"
}
]
}
Lookup paycheck by ID for a detailed view of single paycheck.
Returns details about a paycheck.
Either input was invalid or user was not in necessary state
Client authorization is invalid.
Client requires additional permissions or scopes.
Requested resource could not be found.
Server experienced an unknown or unexpected error.
{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "status": {
- "code": "PROCESSING",
- "description": "The PROCESSING status indicates a paycheck is in processing, and may not contribute to user's balance, based on employer configuration."
}, - "employer_name": "Paddy's Pub",
- "total_balance": {
- "currency": "USD",
- "amount": 7250
}, - "total_earnings": {
- "currency": "USD",
- "amount": 7250
}, - "total_withholdings": {
- "currency": "USD",
- "amount": 7250
}, - "total_transferred": {
- "currency": "USD",
- "amount": 7250
}, - "total_fees_paid": {
- "currency": "USD",
- "amount": 7250
}, - "remainder_account_id": "123e4567-e89b-12d3-a456-426614174000",
- "paycheck_scheduled_at": "2021-04-21T21:30:58.051Z",
- "payday_at": "2021-04-21T21:30:58.051Z",
- "pay_period_starts_at": "2021-04-21T21:30:58.051Z",
- "pay_period_ends_at": "2021-04-21T21:30:58.051Z"
}