API Specifications
Authentication
Engine by MoneyLion will provide testing and production API bearer tokens. All requests to the Engine by MoneyLion API must be authenticated using a bearer token specified in the Authorization header.
The header value is prefixed with the string “Bearer “, so a properly-authenticated request will look similar to the one here:
Post Request
The required format of the body (JSON) in the request to https://api.engine.tech/leads/rateTables
:
More information about key/value pair formatting and acceptable fields can be found here.
Response
Here is a sample response of /rateTables
Savings offers will appear in this schema
Below are the fields used for displaying offers:
Field Description | API Field Name | Example Response | Notes |
Bank Brand Name | partner.name | Citi Bank |
|
FDIC, NCUA status | details.federalInsuranceType | FDIC or NCUA or Null | If null, recommended to not display |
Product Name | details.name | 360 Performance Savings |
|
Bank Logo | partner.imageUrl | https://s3.amazonaws.com/images.engine.tech/logos/prod/lt_-_enablement_api-v2isl9ak.png |
|
APY | details.annualPercentYield | 1.50 | String ‘Annual Percentage Yield’ (can’t shorten to APY) must be displayed and number must be shown as a percentage |
Monthly Fee Amount | details.monthlyFee | 0 | Dollar value to be accompanied by the string ‘Monthly fee’ |
Check Writing Status | details.checkWriting | True | Status to be accompanied by the string ‘Check writing’’ |
Min Balance to Earn APY | details.minimumDeposit | 2500 | Dollar value to be accompanied by the string ‘Min balance to earn APY’ |
Marketing Details | details.description | <ul>\n<li>Lorem</li>\n<li>impsum</li></ul> | Bulleted list of account values that are returned by the Financial Institutions |
As of Date | details.effectiveAsOf | 2022-08-26T13:14:41.396113Z | Must be posted on each card |
Other Important Fields:
Field Description | API Field Name | Example Response | Notes |
Savings, or Money Market Offer or CD Designation | productSubType | savings_account OR money_market_account OR certificate-of-deposit | We will be adding support for Checking and CDs in future upgrades |
Offer Expiration Date/Time | expiresAt | 2022-10-03T16:48:03.504061Z | Offers should not be cached. Offers expire after this timestamp |
Offer Click URL | url | https://offers.engine.tech/ref/864a7925-4abd-42b3-b5a6-68960209e327 | The user should be sent here based on click of the account card |
Asynchronous Flow Responses
Asynchronous Flow - https://api.engine.tech/leads/rateTables
Partners building a Native API integration posting user information to this endpoint will need to make a separate request to retrieve offers. This is the recommended endpoint given the partner’s flexibility to retrieve offers from a separate endpoint.
In the asynchronous flow, creating a rate table does not wait for all of our partners to respond with offers, instead, it contains an array of pending responses ({.pendingResponses}), as well as any resolved offers. You may poll the endpoint using the resulting ID to check for additional offers.
“uuid”: Engine by MoneyLion’s Rate Table UUID which will be used to retrieve offer information
“leadUuid”: Engine by MoneyLion’s Lead UUID which partners building a Native API integration should store for internal records
Here is an example of the API response. Note that pendingResponses
contains information about the Financial Services partners to whom Engine by MoneyLion is sending user information:
In the Asynchronous Flow, partners building a Native API integration must make a secondary request to Engine by MoneyLion’s API to retrieve offer information. Below are instructions for this secondary request:
Capture the “UUID” returned in the initial API response
Execute a GET request to Engine by MoneyLion’s Offers Endpoint –
https://api.engine.tech/originator/rateTables/{uuid}
Poll the endpoint once every second up to 15 seconds, or until “pendingResponses” is empty
Below is an example of the API response for Engine by MoneyLion’s Offers endpoint. Note that pendingResponses
is empty as Engine by MoneyLion has already received offers back for the user from all Financial Services partners.
Synchronous Flow
If you’d like details on supporting a synchronous flow, please contact your Engine by MoneyLion Partner Manager or [email protected] for help.
Last updated