Jump to Content
Guides
API Reference
Release Notes
Log In
API Reference
Log In
Guides
API Reference
Release Notes
Account External Fields
All
Pages
Start typing to search…
JUMP TO
Public
Auth
Get an auth token
post
Webhook Handler
FirstData webhook handler
post
Stripe webhook handler
post
Healthcheck
Check health of the application (reader and writer DB endpoints)
get
Core
Account User Tags
Get all tags associated with an account
get
Apply a tag to an account
post
Remove a tag from an account
del
Accounts
Get accounts
get
Create a new account
post
Gets the account details for a given account id
get
Transfer account ownership to a new organization
post
Account System Tags
Get all system applied tags associated with an account
get
Account External Fields
Update external fields for an account
put
Calculations
Calculate APR and APY for a loan
post
Calculate Nominal Interest Rate for a loan
post
Borrowers
Create a new borrower
post
Create a new business borrower
post
Get a paginated list of borrowers
get
Locale Rule Sets
Create a new locale rule set
post
Get a locale rule set by ID
get
Get all locale rule sets
get
Policies
Get usage information for a specific policy template
get
Get a policy template by ID
get
Get all policy templates
get
Update policies for multiple lines of credit
patch
Create an account template
post
Get all templates for account creation
get
Get policies for a given account
get
Create a line of credit template
post
Get all templates for line of credit creation
get
Get policies for a line of credit
get
Get deferral policies for a line of credit.
get
Update policies for a line of credit
patch
Create an installment loan template
post
Get all templates for installment loan creation
get
Create an advance template
post
Get all templates for advance creation
get
Get deferral policies for an installment loan.
get
User Tags
Get all tags for the organization
get
Add tag to the organization
post
Update a tag option
patch
System Tags
Get all system applied tags
get
Notifications
Get available notification configurations
get
Create a notification configuration for a product or an account
post
Disable the notification configurations that match the provided filters
patch
Get notifications
get
Organizations
Get all organizations
get
Gets the Data Direct connection configuration
get
Gets the Data Direct allow list
get
Adds CIDRs to the Data Direct allow list
post
Deletes CIDRs from the Data Direct allow list
del
Installments
Installment Loans
Creates a new installment loan.
post
Get the installment loans for an account.
get
Get an installment loan by loan_id.
get
Get an installment loan's payment schedule.
get
Get the payment schedule due dates for a loan.
get
Get the periodic payment due for a loan.
get
Change the loan's interest rate.
patch
Deferrals
Defer past, current, or future payment schedule due amounts to later dates.
post
SCRA/MLA Adjustments
Post an MLA adjustment to an installment loan.
post
Post an SCRA adjustment to an installment loan.
post
Transactions
Get a transaction for a loan
get
Get transactions for a loan
get
Statements
Get statements for a loan
get
Get a loan statement by id
get
Revolving
Lines of Credit
Adjust the interest rate for a line of credit.
post
Adjust the interest rate for a line of credit.
post
Get the status history of a line of credit.
get
Create a line of credit for an account
post
Get a line of credit for an account
get
Get the available credit for a line of credit
get
Get all line of credits for an account
get
Get the minimum payment for a line of credit
get
Get the obligations for a line of credit
get
Get the due dates for a line of credit
get
Adjust credit limit for a line of credit
patch
Get history of credit limit changes for a line of credit
get
Adjust the interest rate for a line of credit
patch
Update the status of a line of credit.
patch
Deferrals
Defer past, current, or future payment schedule due amounts to later dates.
post
Draws
Create a draw for a line of credit
post
Capture a portion of an authorized draw
post
Create a backdated draw for a line of credit
post
Fees
Create a fee for a line of credit
post
Offsets
Create an offset for a line of credit
post
Payments
Create a payment for a line of credit
post
Create a backdated payment for a line of credit
post
Statements
Get statements for a line of credit
get
Get a line of credit statement by id
get
Refunds
Create a refund for a line of credit
post
Reversals
Reverse a payment on a line of credit
post
Reverse a draw on a line of credit
post
Transactions
Get a transaction for a line of credit
get
Get transactions for a line of credit
get
Settle a transaction for a line of credit
patch
Update transaction dispute status
put
Update transaction metadata
put
Adjust the balance of a transaction for a line of credit
patch
Get splits related to a transaction for a line of credit
get
Adjust the interest rate for a transaction
patch
Cards
Issue a card for a line of credit
post
Get a card for a line of credit
get
Get cards for a line of credit
get
Update the status of a card for a line of credit (freeze, unfreeze, cancel)
put
Renew a card for a line of credit
post
Advances
Advances
Get a statement for an advance
get
Get an advance for an account
get
Get the payment schedule for an advance
get
Get the minimum payment for an advance
get
Create an advance for an account
post
Get account advances
get
Create a payment for an advance
post
Get paginated transactions for an advance
get
Get transaction for an advance
get
Get splits for an advance transaction
get
Secured
Valuations
Add a valuation to a collateral
post
LTV
Get the Loan To Value ratio
get
Liens
Create a lien
post
Terminate a lien on a collateral
patch
Collaterals
Get a collateral by ID
get
Get collaterals
get
Create a collateral
post
Create an association between a collateral and a loan or a line of credit
post
Substitute collaterals
post
Release a collateral
patch
Powered by
Account External Fields
Ask AI
