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": {
      "payout_status": "released",
      "loan_details_approved_amount": 550000,
      "loan_details_approved_term": 60,
      "loan_details_approved_rate": 11.49,
      "loan_details_approved_monthly_payment": 8795
    }
  }'

{
  "success": true,
  "data":  {
    "id": "elem_sess_bnGnJHX9i4tD3",
    "type": "balance_transfer",
    "balance_transfer": {
        "flow_type": "default",
        "remainder_opt_in": false,
        "auth_session_completed": true,
        "is_first_pass": true,
        "payout_status": "released",
        "payout_ids": {
            "acc_acd7mNt68hcXJ": "pmt_gKAL7e6mka",
            "acc_eKTJpCtFmhdqi": "pmt_p9RqmMAmmw"
        },
        "payout_accounts": {
            "acc_eKTJpCtFmhdqi": 450000,
            "acc_acd7mNt68hcXJ": 100000
        },
        "payout_residual_amount": 0,
        "payout_residual_amount_max": 55000,
        "payout_creditor_amount": 550000,
        "payout_amount_min": 100,
        "minimum_loan_amount": 60000,
        "loan_details_requested_amount": 550000,
        "loan_details_requested_rate": 11.49,
        "loan_details_requested_term": 60,
        "loan_details_requested_monthly_payment": 8795,
        "loan_details_approved_amount": 550000,
        "loan_details_approved_rate": 11.49,
        "loan_details_approved_term": 60,
        "loan_details_approved_monthly_payment": 8795,
        "skip_intro": true
    },
    "created_at": "2024-10-15T14:53:04.073Z",
    "updated_at": "2024-10-15T14:53:28.055Z"
  },
  "message": null
}

Release funds for a balance transfer session.

​
Body

​
balance_transfer
object

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

​
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": {
      "payout_status": "released",
      "loan_details_approved_amount": 550000,
      "loan_details_approved_term": 60,
      "loan_details_approved_rate": 11.49,
      "loan_details_approved_monthly_payment": 8795
    }
  }'

{
  "success": true,
  "data":  {
    "id": "elem_sess_bnGnJHX9i4tD3",
    "type": "balance_transfer",
    "balance_transfer": {
        "flow_type": "default",
        "remainder_opt_in": false,
        "auth_session_completed": true,
        "is_first_pass": true,
        "payout_status": "released",
        "payout_ids": {
            "acc_acd7mNt68hcXJ": "pmt_gKAL7e6mka",
            "acc_eKTJpCtFmhdqi": "pmt_p9RqmMAmmw"
        },
        "payout_accounts": {
            "acc_eKTJpCtFmhdqi": 450000,
            "acc_acd7mNt68hcXJ": 100000
        },
        "payout_residual_amount": 0,
        "payout_residual_amount_max": 55000,
        "payout_creditor_amount": 550000,
        "payout_amount_min": 100,
        "minimum_loan_amount": 60000,
        "loan_details_requested_amount": 550000,
        "loan_details_requested_rate": 11.49,
        "loan_details_requested_term": 60,
        "loan_details_requested_monthly_payment": 8795,
        "loan_details_approved_amount": 550000,
        "loan_details_approved_rate": 11.49,
        "loan_details_approved_term": 60,
        "loan_details_approved_monthly_payment": 8795,
        "skip_intro": true
    },
    "created_at": "2024-10-15T14:53:04.073Z",
    "updated_at": "2024-10-15T14:53:28.055Z"
  },
  "message": null
}
Create or Update SessionThe event endpoint