Create an Element Token

POST

elements

token

curl https://production.methodfi.com/elements/token \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connect",
    "connect": {
      "products": ["balance"],
      "entity": {
        "type": "individual",
        "individual": {
          "first_name": "Kevin",
          "last_name": "Doyle"
        }
      }
    }
  }'

{
  "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G"
}

Element tokens are used as the starting point and authentication key to instantiate Method’s embeddable UI components within your experience.

For security purposes, element tokens are for one-time use only, and expire after 30 minutes.

Body

The structure of the request body differs slightly depending on the type of Element you are trying to use. See the Elements Guide for more information about specific flows.

Either entity_id or connect.entity is required.

type

enum

required

The name of the element type you want to generate the token for. One of connect or balance_transfer

entity_id

string

An existing entity id that the Element session will initiate for.

team_name

string

The name of the team that will be displayed in the Element.

team_logo

string

A URL to an image that will be used as the logo in the Element.

connect

object

Information needed if creating a Connect Element token.

Show properties

products

enum

The account products that you want to Connect this entity's accounts with. One of balance, sensitive, payoff, transactions, update or payment

accounts

array

A list of accounts associated with the entity that you want to Connect (note entity_id must also be provided).

entity

object

Information about the entity that the Element session will initiate for. See the Individual Entity page for information about fields in the individual object.

account_filters

object

Optional filters to restrict which liability types are shown or to restrict how many accounts the user can select.

Show properties

liability_types

enum

A list of liability types that should be shown for the user. One of auto_loan, mortgage, credit_card, loan, student_loan or personal_loan

selection_type

enum

Indicates whether the user should be able to only select one or multiple accounts. One of single or multiple

balance_transfer

object

Information needed if creating a Balance Transfer Element token.

Show properties

payout_amount_min

number

required

The minimum amount that needs to be paid out per creditor.

minimum_loan_amount

number

required

The minimum loan amount that should be requested.

payout_residual_amount_max

number

required

The maximum residual amount that can be paid out, after payments to creditors.

loan_details_requested_amount

number

required

The amount of the loan that is requested.

loan_details_requested_rate

number

required

The interest rate of the loan that is requested.

loan_details_requested_term

number

required

The term of the loan that is requested.

loan_details_requested_monthly_payment

number

required

The monthly payment of the loan that is requested.

Returns

The element token that was created.

curl https://production.methodfi.com/elements/token \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connect",
    "connect": {
      "products": ["balance"],
      "entity": {
        "type": "individual",
        "individual": {
          "first_name": "Kevin",
          "last_name": "Doyle"
        }
      }
    }
  }'

{
  "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G"
}

curl https://production.methodfi.com/elements/token \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connect",
    "connect": {
      "products": ["balance"],
      "entity": {
        "type": "individual",
        "individual": {
          "first_name": "Kevin",
          "last_name": "Doyle"
        }
      }
    }
  }'

{
  "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G"
}

POST

elements

token

curl https://production.methodfi.com/elements/token \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connect",
    "connect": {
      "products": ["balance"],
      "entity": {
        "type": "individual",
        "individual": {
          "first_name": "Kevin",
          "last_name": "Doyle"
        }
      }
    }
  }'

{
  "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G"
}

Element tokens are used as the starting point and authentication key to instantiate Method’s embeddable UI components within your experience.

For security purposes, element tokens are for one-time use only, and expire after 30 minutes.

Body

The structure of the request body differs slightly depending on the type of Element you are trying to use. See the Elements Guide for more information about specific flows.

Either entity_id or connect.entity is required.

type

enum

required

The name of the element type you want to generate the token for. One of connect or balance_transfer

entity_id

string

An existing entity id that the Element session will initiate for.

team_name

string

The name of the team that will be displayed in the Element.

team_logo

string

A URL to an image that will be used as the logo in the Element.

connect

object

Information needed if creating a Connect Element token.

Show properties

products

enum

The account products that you want to Connect this entity's accounts with. One of balance, sensitive, payoff, transactions, update or payment

accounts

array

A list of accounts associated with the entity that you want to Connect (note entity_id must also be provided).

entity

object

Information about the entity that the Element session will initiate for. See the Individual Entity page for information about fields in the individual object.

account_filters

object

Optional filters to restrict which liability types are shown or to restrict how many accounts the user can select.

Show properties

liability_types

enum

A list of liability types that should be shown for the user. One of auto_loan, mortgage, credit_card, loan, student_loan or personal_loan

selection_type

enum

Indicates whether the user should be able to only select one or multiple accounts. One of single or multiple

balance_transfer

object

Information needed if creating a Balance Transfer Element token.

Show properties

payout_amount_min

number

required

The minimum amount that needs to be paid out per creditor.

minimum_loan_amount

number

required

The minimum loan amount that should be requested.

payout_residual_amount_max

number

required

The maximum residual amount that can be paid out, after payments to creditors.

loan_details_requested_amount

number

required

The amount of the loan that is requested.

loan_details_requested_rate

number

required

The interest rate of the loan that is requested.

loan_details_requested_term

number

required

The term of the loan that is requested.

loan_details_requested_monthly_payment

number

required

The monthly payment of the loan that is requested.

Returns

The element token that was created.

curl https://production.methodfi.com/elements/token \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connect",
    "connect": {
      "products": ["balance"],
      "entity": {
        "type": "individual",
        "individual": {
          "first_name": "Kevin",
          "last_name": "Doyle"
        }
      }
    }
  }'

{
  "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G"
}

curl https://production.methodfi.com/elements/token \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connect",
    "connect": {
      "products": ["balance"],
      "entity": {
        "type": "individual",
        "individual": {
          "first_name": "Kevin",
          "last_name": "Doyle"
        }
      }
    }
  }'

{
  "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G"
}

Body

Returns

Changelog

API Versions

Create an Element Token

Body

Returns

​Body

​Returns

Changelog

API Versions

​Body

​Returns

Body

Returns

Body

Returns