Create Disbursement

post

https://api.branchapp.com/v1/organizations/{orgId}/employees/{employeeId}/disbursements

Creates a disbursement for an employee. This initiates a payment to the employee.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

int32

required

Organization ID

employeeId

string

required

Employee ID

Body Params

amount

int64

required

≥ 0

Amount, in cents, to be disbursed to the employee.

external_id

string

required

length between 0 and 64

Allows the custom specification of a unique ID that correlates back to your own records.

type

string

enum

required

TIPS: Disbursement for tips earned by worker

TRIP: Disbursement for trip made by worker

MILEAGE: Disbursement for miles driven by worker

PAYCHECK: Disbursement for income earned by worker

MISCELLANEOUS: Disbursement to worker for miscellaneous reasons

DEVICE: Disbursement for a worker’s device

DELIVERY: Disbursement for delivery made by worker

DEPOSIT: Disbursement for generic purposes

REWARD: Disbursement for a reward earned

PER_DIEM: Disbursement for per diem reimbursement

BONUS: Disbursement representing a non-usual payment

employee_group

string

length between 0 and 150

A grouping for the employee. This could be anything that is used by your organization in order to group employees: store id, employee tier, region code, etc.

display_sub_label

string

length between 0 and 150

The sub label of the disbursement. This will be displayed to the employee in the application. If left blank, will default to the organization name or a template value configured in organization settings

description

string

required

length between 0 and 256

The description of the disbursement. This will be displayed in PayAdmin, and is not visible to the employee

retry

boolean

Defaults to false

If a disbursement with matching external_id and type exists, and status != COMPLETED, will retry instead of skipping.

metadata

object

Accepts custom JSON. Format definition

time_scheduled

date-time

Date and time at which the specified amount will be disbursed to the employee.

Response

201Created