logo

Users

Information about a DailyPay user

Get a user

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.

SecurityuserBearerAuth
Responses
200

Full description of a user.

400

Either input was invalid or user was not in necessary state

401

Client authorization is invalid.

404

Requested resource could not be found.

500

Server experienced an unknown or unexpected error.

get/user
Request samples 
Response samples 
application/json
{
  • "scopes": [
    ],
  • "user_id": "123e4567-e89b-12d3-a456-426614174000",
  • "full_name": "George Costanza",
  • "status": {
    },
  • "earnings_balance": {
    },
  • "negative_balance": {
    },
  • "remainder_setup_required": true,
  • "negative_balance_payoff_enrollment_required": true,
  • "transfer_fees": {
    },
  • "employers": [
    ]
}
Get user details
Returns details about a user via their Unique User ID.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user to get the details for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Responses 
200
Full description of a user.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}
Request samples 
Response samples 
application/json
{
  • "scopes": [
    ],
  • "user_id": "123e4567-e89b-12d3-a456-426614174000",
  • "full_name": "George Costanza",
  • "status": {
    },
  • "earnings_balance": {
    },
  • "negative_balance": {
    },
  • "remainder_setup_required": true,
  • "negative_balance_payoff_enrollment_required": true,
  • "transfer_fees": {
    },
  • "employers": [
    ]
}
Get transfer accounts
Get all transfer accounts for a user.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user to get transfer accounts for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Responses 
200
Returns the details of the user's transfer accounts.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/transfer_accounts
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Create a transfer account
Add a transfer account for a user. A user can have multiple transfer accounts.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string
Unique ID of the user to create transfer account for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Request Body schema: application/json
required
An account to use as the transfer account for the user.


required
BankAccount (object) or DebitCard (object) or DebitCard_VendorSpecific_Galileo (object) or DebitCard_VendorSpecific_Wisely (object)
Input required to create a transfer account. See schemas for DebitCard or BankAccount to view the required input format.


 
transfer_account_type
required
any
The type of account, e.g., a bank account


 Enum: "BANK_ACCOUNT" "DEBIT_CARD"  
 Example:  "BANK_ACCOUNT"
Responses 
200
Return transfer account that was created.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


post/users/{user_id}/transfer_accounts
Request samples 
application/json
{
  • "transfer_account_type": "BANK_ACCOUNT",
  • "transfer_account": {
    }
}
Response samples 
application/json
{
  • "id": "10b3d654-c6ed-40d8-9177-434942d04114",
  • "type": "BANK_ACCOUNT",
  • "status": {
    },
  • "data": {
    }
}
Get a transfer account
Get a transfer account by ID.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
transfer_account_id
required
string (ResourceId) 
The ID returned when making POST request to /user/transfer_accounts.


 
 Example:  045ee9e8-844e-11ec-a8a3-0242ac120002
user_id
required
string (ResourceId) 
Unique ID of the user to get transfer account for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Responses 
200
Returns the details of the user's transfer account


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/transfer_accounts/{transfer_account_id}
Request samples 
Response samples 
application/json
{
  • "id": "10b3d654-c6ed-40d8-9177-434942d04114",
  • "type": "BANK_ACCOUNT",
  • "status": {
    },
  • "data": {
    }
}
Get a remainder account
Get the remainder account for a user.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user to get remainder account for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Responses 
200
Returns the details of the user's remainder account.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/remainder_account
Request samples 
Response samples 
application/json
{
  • "first_name": "George",
  • "last_name": "Costanza",
  • "routing_number": "XXXXX4321",
  • "account_number": "XXXXXX4321",
  • "is_checking": false,
  • "is_rtp": false,
  • "schedule_options": [
    ]
}
Update a remainder account
Create or update the remainder account for a user. There can only be one configured remainder account a time.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string
Unique ID of the user to create/update remainder account for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Request Body schema: application/json
required
A bank account to use as the remainder account for the user.


account_number
required
string
The account number. Responses from this API that return this number are masked to the last four digits.


 
 Example:  "0123454321"
first_name
string
The first name of the account holder.


 
 Example:  "George"
last_name
string
The last name of the account holder.


 
 Example:  "Costanza"
routing_number
required
string
The routing number of the bank that holds this account. Responses from this API that return this number are masked to the last four digits.


 
 Example:  "123454321"
Responses 
200
Returns updated remainder bank account.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


put/users/{user_id}/remainder_account
Request samples 
application/json
{
  • "first_name": "George",
  • "last_name": "Costanza",
  • "routing_number": "123454321",
  • "account_number": "0123454321"
}
Response samples 
application/json
{
  • "first_name": "George",
  • "last_name": "Costanza",
  • "routing_number": "XXXXX4321",
  • "account_number": "XXXXXX4321",
  • "is_checking": false,
  • "is_rtp": false,
  • "schedule_options": [
    ]
}
Get a transfer
Look up the status of a transfer.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
id
required
string (ResourceId) 
The ID used in the original POST request to /user/transfers.


 
 Example:  26e8345f-f181-4c0b-bd97-74823dd91668
user_id
required
string (ResourceId) 
Unique ID of the user to get transfer info for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Responses 
200
Reports the status of the requested transfer.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/transfers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "26e8345f-f181-4c0b-bd97-74823dd91668",
  • "status": {
    },
  • "schedule": "NEXT_BUSINESS_DAY",
  • "transfer_account_id": "12345",
  • "amount": {
    },
  • "fees_charged": {
    },
  • "reason": "TRANSFER",
  • "date_submitted": "2021-04-21T21:30:58.051Z",
  • "date_resolved": "2021-04-21T21:30:58.051Z",
  • "paycheck_ids": [
    ]
}
List transfers
Get the 25 most recent transfers (user initiated advances and remainder payments) for a user.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user to get transfers for.


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Responses 
200
Returns the details of the user's transfers.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/transfers
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Request a transfer
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.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user to create transfer for


 
 Example:  f5fc4d96-844d-11ec-a8a3-0242ac120002
Request Body schema: application/json
required
required
object (MonetaryAmount) 
The amount requested requested by the user


 
schedule
string
 Default:  "WITHIN_30_MINUTES"
Specify when to send this transfer. A default of WITHIN_THIRTY_MINUTES is used if schedule is unspecified. The NEXT_BUSINESS_DAY schedule is only supported for bank accounts. The WITHIN_30_MINUTES schedule is only supported for bank accounts that support RTP, and debit cards.


 Enum: "NEXT_BUSINESS_DAY" "WITHIN_30_MINUTES"  
 Example:  "WITHIN_30_MINUTES"
transfer_account_id
required
string
Unique ID of the transfer account as returned by the /user/transfer_accounts endpoint on creation


 
 Example:  "123e4567-e89b-12d3-a456-426614174000"
transfer_id
required
string
Client-provided ID to associate to this transfer


 
 Example:  "MTIzNDUxMjM0NTEyMzQ1MTIzNDU"
Responses 
200
Reports the status of the transfer


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


post/users/{user_id}/transfers
Request samples 
application/json
{
  • "transfer_account_id": "123e4567-e89b-12d3-a456-426614174000",
  • "transfer_id": "MTIzNDUxMjM0NTEyMzQ1MTIzNDU",
  • "amount": {
    },
  • "schedule": "WITHIN_30_MINUTES"
}
Response samples 
application/json
{
  • "id": "26e8345f-f181-4c0b-bd97-74823dd91668",
  • "status": {
    },
  • "schedule": "NEXT_BUSINESS_DAY",
  • "transfer_account_id": "12345",
  • "amount": {
    },
  • "fees_charged": {
    },
  • "reason": "TRANSFER",
  • "date_submitted": "2021-04-21T21:30:58.051Z",
  • "date_resolved": "2021-04-21T21:30:58.051Z",
  • "paycheck_ids": [
    ]
}
Get balance details
View details on user's balance and current pay period


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
Responses 
200
User's balance details.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/balance_details
Request samples 
Response samples 
application/json
{
  • "last_shift_reported_at": "2021-04-21T21:30:58.051Z",
  • "detailed_user_status": "active"
}
List paychecks
Get 25 most recent paychecks, including paychecks that have not yet been deposited.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
user_id
required
string (ResourceId) 
Unique ID of the user to list paychecks for.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
Responses 
200
Returns the details of the user's paychecks.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


403
Client requires additional permissions or scopes.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/paychecks
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}
Get a paycheck
Lookup paycheck by ID for a detailed view of single paycheck.


SecurityclientBasicAuth or userBearerAuth 
Request 
path Parameters
paycheck_id
required
string (ResourceId) 
Unique ID of the paycheck to view.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
user_id
required
string (ResourceId) 
Unique ID of the user to list paychecks for.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
Responses 
200
Returns details about a paycheck.


400
Either input was invalid or user was not in necessary state


401
Client authorization is invalid.


403
Client requires additional permissions or scopes.


404
Requested resource could not be found.


500
Server experienced an unknown or unexpected error.


get/users/{user_id}/paychecks/{paycheck_id}
Request samples 
Response samples 
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": {
    },
  • "employer_name": "Paddy's Pub",
  • "total_balance": {
    },
  • "total_earnings": {
    },
  • "total_withholdings": {
    },
  • "total_transferred": {
    },
  • "total_fees_paid": {
    },
  • "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"
}
➔ Next to Organizations