API Reference

Create Wallet

post
https://api.branchapp.com/v1/organizations//employees//wallets

Creates a digital wallet for an employee. Optionally allows a Branch card to be automatically ordered for the employee.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Organization ID

string
required
length ≤ 512

Employee ID

Body Params
string
required
length between 1 and 40

The worker's first name (numbers not allowed)

string
length between 0 and 40

The worker's middle name (numbers not allowed)

string
required
length between 1 and 40

The worker's last name (numbers not allowed)

address
object
required
string
required
length ≥ 1

Birthdate provided must indicate greater than 14 years of age. Some organizations may not allow accounts if the age is not 18 or greater.

string
required
length ≥ 1

The worker's Social Security Number

string
required

The worker's phone number

string
required
length between 1 and 255

The worker's email address

string
enum

The worker's wage type

Allowed:
int32
≥ 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

string

An additional layer of categorization within an organization allowing for more granular customized settings

boolean
Defaults to false

If true and the employee does not already exist, will create the employee with the given information.

boolean
Defaults to false

If true, a physical card will be shipped to the user when the wallet is claimed.

string

Specifies which card should be ordered and delivered to the user. Available options for an organization can be found by querying the card-controller -> getCardPrograms endpoint.Default is organization's default card program - generally BRANCH_W2

string

9 digit employer identification number

string

A cosmetic descriptor of the employee's workplace

Headers
boolean
Defaults to false

Enables test scenarios based on the supplied test SSN

Responses

Updated 7 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago