API Reference
Entities
- The entity endpoint
- POSTCreate an Individual
- POSTCreate a Corporation
- PUTUpdate an Entity
- GETRetrieve an Entity
- GETList all Entities
- Connect
- Verification Sessions
- Credit Scores
- Attributes
- Vehicles
- Identities
- Products
- Subscriptions
- Consent
Accounts
- The account endpoint
- POSTCreate an Account
- GETRetrieve an Account
- GETList all Accounts
- Updates
- Transactions
- Card Brand
- Attributes
- Payoffs
- Balances
- Sensitive
- Products
- Subscriptions
- Verification Sessions
- Consent
Payments
Elements
Supporting Endpoints
- Merchants
- Webhooks
- Reports
- Simulations (Dev)
- Health Check
The sessions endpoint
{
"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"
}
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.
Method Session is currently only available for Method Balance Transfer.
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.
The type of flow to start.
The borrower should be disbursed the remaining funds from the loan.
The user is on their first pass through the balance transfer element. Multiple passes may be used for counter offers.
The status of the payout. One of pending_accounts
, pending_release
or released
A map of account IDs with their matching payment IDs.
A map of account IDs with their matching payment amounts.
The amount that will be paid out to the borrower.
The amount that will be paid to the creditor.
The minimum amount that can be paid out to a single creditor.
The minimum amount that can be loaned.
The maximum amount that can be paid out to the borrower.
The amount requested for the loan.
The term requested for the loan.
The rate requested for the loan.
The monthly payment requested for the loan.
The amount approved for the loan.
The term approved for the loan.
The rate approved for the loan.
The monthly payment approved for the loan.
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"
}
{
"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"
}