Sessions
Update Session
POST
/
elements
/
token
Update an element session using the session ID.
Body
type
enum
requiredThe type of session to start. Must be balance_transfer
entity_id
string
requiredThe ID of the associated Entity.
balance_transfer
object, null
The balance transfer object to be processed.
element_session_id
string
requiredThe ID of the Element Session to update. Required for updating a session. If not provided, a new session will be created.
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.