Sessions are a way for users to interact with Method Elements in a more stateful way.
You will be able to create, update, and retrieve session data each time a user travels through the Element.
Each Element Token will still expire 30 minutes after creation. If the
element session is not completed within that time limit, another element token
will need to be generated with the same session in order to resume.
Session Objects Unique identifier for the Session.
The type of Session. Must be balance_transfer
Status of the Session. One of active or inactive
The balance transfer object to be processed. balance_transfer.flow_type
The type of flow to start.
balance_transfer.remainder_opt_in
The borrower should be disbursed the remaining funds from the loan.
balance_transfer.is_first_pass
The user is on their first pass through the balance transfer element. Multiple passes may be used for counter offers.
balance_transfer.payout_status
The status of the payout. One of pending_accounts, pending_release or released
balance_transfer.payout_ids
A map of account IDs with their matching payment IDs.
balance_transfer.payout_accounts
A map of account IDs with their matching payment amounts.
balance_transfer.payout_residual_amount
The amount that will be paid out to the borrower.
balance_transfer.payout_creditor_amount
The amount that will be paid to the creditor.
balance_transfer.payout_amount_min
The minimum amount that can be paid out to a single creditor.
balance_transfer.minimum_loan_amount
The minimum amount that can be loaned.
balance_transfer.payout_residual_amount_max
The maximum amount that can be paid out to the borrower.
balance_transfer.loan_details_requested_amount
The amount requested for the loan.
balance_transfer.loan_details_requested_term
The term requested for the loan.
balance_transfer.loan_details_requested_rate
The rate requested for the loan.
balance_transfer.loan_details_requested_monthly_payment
The monthly payment requested for the loan.
balance_transfer.loan_details_approved_amount
The amount approved for the loan.
balance_transfer.loan_details_approved_term
The term approved for the loan.
balance_transfer.loan_details_approved_rate
The rate approved for the loan.
balance_transfer.loan_details_approved_monthly_payment
The monthly payment approved for the loan.
balance_transfer.skip_intro
Skip the intro screen of the balance transfer element.
Timestamp of when the Session was created.
Timestamp of when the Session was last updated.
{ "id" : "elem_sess_bTgeR3QzqApfJ" , "type" : "balance_transfer" , "status" : "active" , "balance_transfer" : { "flow_type" : "default" , "remainder_opt_in" : null , "auth_session_completed" : false , "is_first_pass" : true , "payout_status" : "pending_accounts" , "payout_ids" : {}, "payout_accounts" : {}, "payout_residual_amount" : null , "payout_residual_amount_max" : 56000 , "payout_creditor_amount" : null , "payout_amount_min" : 50000 , "minimum_loan_amount" : 200000 , "loan_details_requested_amount" : 560000 , "loan_details_requested_rate" : 3.6 , "loan_details_requested_term" : 12 , "loan_details_requested_monthly_payment" : 17500 , "loan_details_approved_amount" : null , "loan_details_approved_rate" : null , "loan_details_approved_term" : null , "loan_details_approved_monthly_payment" : null , "skip_intro" : true }, "created_at" : "2024-05-02T18:32:36.457Z" , "updated_at" : "2024-05-02T18:32:36.457Z" } 
