POST
/
elements
/
token

Starting an Element Session is as simple as creating an Element Token with a supported Session type

Body

type
enum
required

The type of session to start. Must be balance_transfer

entity_id
string
required

The ID of the associated Entity.

balance_transfer
object, null

The balance transfer object to be processed.

Additional fields based on session type

balance_transfer
object, null

The balance transfer object to be processed.

balance_transfer.flow_type
string

The type of flow to start.

balance_transfer.payout_amount_min
number

The minimum amount that has be paid out.

balance_transfer.minimum_loan_amount
number

The minimum amount that can be loaned.

balance_transfer.payout_residual_amount_max
number

The maximum amount that can be paid out.

balance_transfer.loan_details_requested_amount
number

The amount requested for the loan.

balance_transfer.loan_details_requested_term
number

The term requested for the loan.

balance_transfer.loan_details_requested_rate
number

The rate requested for the loan.

balance_transfer.loan_details_requested_monthly_payment
number

The monthly payment requested for the loan.

Returns

Returns a Session object.