PUT
/
elements
/
sessions
/
:session_id
curl --location '{BASE_URL}/elements/sessions/:session_id' \
  -H 'Authorization: Bearer {API_KEY}'
  -H 'Content-Type: application/json'
  -d '{
    "balance_transfer": {
      "loan_details_approved_amount": 1000,
      "loan_details_approved_term": 12,
      "loan_details_approved_rate": 0.1,
      "loan_details_approved_monthly_payment": 100
    }
  }'

{
  "success": true,
  "data": {
    "id": "elem_sess_iEJz3DWaTpeJG",
    "type": "balance_transfer",
    "balance_transfer": {
      "flow_type": "penfed_dpo",
      "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-04-15T20:50:51.251Z",
    "updated_at": "2024-04-15T20:51:59.426Z"
  },
  "message": null
}

Update a Session object by its ID.

​
Body

balance_transfer
object

The balance transfer object containing fields to update. See Guides for more information

​
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.

curl --location '{BASE_URL}/elements/sessions/:session_id' \
  -H 'Authorization: Bearer {API_KEY}'
  -H 'Content-Type: application/json'
  -d '{
    "balance_transfer": {
      "loan_details_approved_amount": 1000,
      "loan_details_approved_term": 12,
      "loan_details_approved_rate": 0.1,
      "loan_details_approved_monthly_payment": 100
    }
  }'

{
  "success": true,
  "data": {
    "id": "elem_sess_iEJz3DWaTpeJG",
    "type": "balance_transfer",
    "balance_transfer": {
      "flow_type": "penfed_dpo",
      "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-04-15T20:50:51.251Z",
    "updated_at": "2024-04-15T20:51:59.426Z"
  },
  "message": null
}
Create SessionThe merchant endpoint