GET
/
elements
/
sessions
/
:session_id
curl '{BASE_URL}/elements/sessions/:session_id' \
  -H 'Authorization: Bearer {API_KEY}'
{
  "success": true,
  "data": {
    "id": "elem_sess_bTgeRWQ3qApfJ",
    "type": "balance_transfer",
    "status": "active",
    "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-05-02T18:32:36.457Z",
    "updated_at": "2024-05-02T18:32:36.457Z"
  },
  "message": null
}

Path Parameters

session_id
string
required

ID of the Session.

Returns

Returns a Session object.

curl '{BASE_URL}/elements/sessions/:session_id' \
  -H 'Authorization: Bearer {API_KEY}'
{
  "success": true,
  "data": {
    "id": "elem_sess_bTgeRWQ3qApfJ",
    "type": "balance_transfer",
    "status": "active",
    "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-05-02T18:32:36.457Z",
    "updated_at": "2024-05-02T18:32:36.457Z"
  },
  "message": null
}