Skip to content

External Accounts

This endpoint provides methods to transfer funds to and from external bank accounts. These accounts can be in the user's own bank or in any other bank. Two types of external accounts are supported:

  1. Basic US checking/savings accounts
  2. Debit cards
Endpoint or Section Action
External Account Object Explanation of the external account object
/externalaccounts/sync List, create, modify, or delete external accounts belonging to a specified user
/externalaccount/verify Checks if an account is already verified and, if not, calls the backoffice API for verification
/externalaccount/pull Pulls a specified amount of money from the external account
/externalaccount/push Pushes a specified amount of money to the external account
/externalaccount/linktoken Generates a link token to identify the external account
/externalaccount/autofunding Setup or modify autofunding for this account

External Account Object

An external account is represented by an external account object. This may include the following properties:

Properties Description Schema Example Values
AFiExternalAccountId The external account ID in ampliFi, (required if updating/deleting account information) String "qweealasgjrtselpavxaxxrjx"
backOfficeId The back office ID, (required if updating/deleting account information) String "evolve"
backOfficeName The back office name, (required if updating/deleting account information) String "evolve"
dtsCreated The date-time stamp when the account was added to ampliFi, (optional) String "2022-11-22T16:55:23.174Z"
dtsModified The date-time stamp when the account details were last modified in ampliFi, (required if updating/deleting account information) String "2022-11-22T16:55:23.174Z"
type The type of account, (required) String "CHECKING", "SAVINGS", or "DEBITCARD"
title The account title, (optional, default is ${firstName} ${lastName}) String "John Testman"
countryCode 3-letter country code (for checking/savings accounts) or 2-letter country code (for debit cards), ISO 3166-1 alpha-3 format, (optional, default is USA) String "USA" or "US"
currency 3-letter ISO alphabetic code to identify the currency, (optional, default is USD) String "USD"
accountNumberMasked Account number that has been masked except for the last 4 digits, (optional) String "****1234"
isSync True if processing should be synchronous, (optional, default is true) Boolean true or false
isActive True if the account is active, (optional, default is true) Boolean true or false
isEnabled True if the account is enabled, (optional, default is true) Boolean true or false
isPullAllowed True if funds can be pulled from the account, (optional, default is true) Boolean true or false
isPushAllowed True if funds can be pushed to the account, (optional, default is true) Boolean true or false
isVerified True if the account is verified, (optional) Boolean true or false
name Name of the account, (optional) String "My personal checking account"
isSyncedToServer True if the account is synced to the server, (optional, default is true) Boolean true or false
comment Brief description of the account, (optional) String "External savings account"
Properties Specific to Checking/Savings Accounts Description Schema Example Values
accountNumber The external account number corresponding to the account String, regex pattern "^\d+$" "12345678901234"
routingNumber The external US ABA account routing number String, regex pattern "^\d{9}$" "123456789"
bankName The name of the bank with whom the account is associated String "Bank of America"
isOwn True if the account is at the user's own bank, optional Boolean true or false
Properties Specific to Debit Cards Description Schema Example Values
panMasked The debit card primary account number (PAN) that has been masked except for the last 4 digits String "1...2345"
dtsExpires The date-time when the account expires in the ampliFi system String "2025-12-01T04:59:59.999Z"
expiryYYYYMM The expiration date on the card in YYYYMM format String "202511"
name_on_card The name as it appears on the debit card String "John Testman"

Back to Top

Sync

Request method and URL:

POST /externalaccounts/sync

Description:

This method can list, create, modify, or delete external accounts belonging to a specified user. The ampliFi user id must be passed in the request body.

  • If you send a record containing only "externalAccounts" : [], the method will list all external accounts currently registered for the logged in user.
  • If you send an account object for a new external account, with no AFiExternalAccountId, the server will validate and register the account. For new external checking/savings accounts, you must include the "accountNumber", "routingNumber", "type", and "bankName". For new external debit cards, you must include the "pan", "cvv", "expiryYYYYMM" or "expiryYY" AND "expiryMM", and "type".
  • If you send a record with an existing AFiExternalAccountId, along with additional properties to be changed ("isActive" or "name"), the server will validate and register the changes. Required properties necessary for modifying an account are: "AFiExternalAccountId", "backOfficeId", "backOfficeName", "dtsModified", and "isActive". The "name" property is optional.
  • If you send a record with an existing AFiExternalAccountId containing "isDeleted": true, the account will be marked for deletion.

In any case, the server will reply with an array of external account objects. These objects will be modified as follows:

  • The following properties will be deleted: AfiUserId, externalAccountIdBO, cardImageFront, cardImageBack
  • The account number, if any, will be masked; all but the last 4 digits will be replaced with stars (*).
  • Various sensitive and personally identifying information will be removed.
Required Properties Description Schema Example Values
externalAccounts An array of external account objects Array [{//account object 1, see External Account Object}, {//account object 2}, ...]

Request headers:

{
    "Content-Type": "application/json",
    "token": "a long random string" //Authorization token received from /token request
}

Request body examples:

{
    "externalAccounts": [ // array of one or more external account objects (if empty will return all external accounts for the user)
  ]
}

In this example, the method will list all external accounts registered for the currently logged in user (AfiUserId).

{
    "externalAccounts": [ //empty
    ]
}

In this example, a new external checking account is synced with the currently logged in user (AfiUserId).

{
    "externalAccounts": [
        {
            "isSync": "false", //boolean, true if syncronous, false if asyncronous
            "isActive": true, //boolean, true if account is active
            "accountNumber": "12345678901234", //account number
            "routingNumber": "123456789", //a US ABA account routing number
            "type": "CHECKING", //"CHECKING", "SAVINGS", or "DEBITCARD"
            "title": "John Testman", //optional. By default ${firstName} ${lastName}
            "bankName": "Bank of America", //name of the bank with whom the account is associated
            "isOwn": true, //default true
            "countryCode": "USA", //default USA, 3-letter country code, ISO 3166-1 alpha-3 format
            "currency": "USD", //default USD, 3-letter ISO alphabetic code to identify the currency
            "comment": "External checking account" //brief description of account
        }
    ]
}

In this example, a AFiExternalAccountId is given to indicate a specific external account that should be updated with requested changes. If an existing record is to be modified, you will need to include "AFiExternalAccountId", "backOfficeId", "backOfficeName", new "dtsModified" (must be greater than the "dtsModified" returned by the system). The external account properties that can currently be updated include "isActive" and "name". You may update "isActive" to false, but you may not update an inactive external account back to true from this endpoint. You may add the "name" property or update the value of the "name" property.

{
    "externalAccounts": [
        {
            "AFiExternalAccountId": "qweealasgjrtselpavxaxxrjx", //the external account ID in the ampliFi system
            "backOfficeId": "evolve", //required, back office ID that was returned when the external account was first synced
            "backOfficeName": "evolve", //required, back office name that was returned when the external account was first synced
            "dtsModified": "2022-11-22T17:56:23.174Z", //required, must be a later date than the dtsModified that was returned when the account was first synced
            "isActive": true, //can update to false using this endpoint, cannot update an inactive account to true from this endpoint
            "comment": "Updated account message", //does not currently update changes
            "name": "Account name update" //can add or update the name field using this endpoint
        }
    ]
}

In this example, an external debit card is added to the currently logged in user.

{
    "externalAccounts": [
        {
            "pan": "1234567890123456", //16-digit debit card primary account number (PAN)
            "cvv": "123", //cvv code on the back of the card
            "type": "DEBITCARD", //"CHECKING", "SAVINGS", or "DEBITCARD"
            "expiryYYYYMM": "202511", //expiration date of debit card in YYYYMM format OR
            //"expiryYY": "25", //not needed if expiryYYYYMM is included
            //"expiryMM": "11:, //not needed if expiryYYYYMM is included
            "comment": "External debit card account" //brief description of account
        }
    ]
}

Possible responses:

  {
    "externalAccounts": [ // array of external account objects
    ],
    "success": true //Success
  }

200 (HTTP response status code) -- Success, external accounts currently registered for user listed

In this example, the request body contained an external account object containing savings account details for the account to be synced to ampliFi. The external accounts currently registered for the specified user were returned (there was already an external checking account associated with this user, so both the existing checking account and the newly synced savings account details were returned).

{
    "externalAccounts": [ //array containing external account objects for the specified user
        {
            "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
            "backOfficeId": "evolve", 
            "backOfficeName": "evolve",
            "dtsCreated": "2022-11-22T16:47:46.190Z", //date the account was added to ampliFi
            "dtsModified": "2022-11-22T16:47:46.190Z", //date of last modification to the account in ampliFi
            "isActive": true, //boolean, true if the account is active
            "isEnabled": true, //boolean, true if the account is enabled
            "isPullAllowed": true, //boolean, true if funds can be pulled from the account
            "isPushAllowed": true, //boolean, true if funds can be pushed to the account
            "comment": "External checking account", //brief description of account
            "accountNumber": "12345678901234", //account number
            "routingNumber": "123456789", //a US ABA account routing number
            "type": "CHECKING", //type of account, "CHECKING", "SAVINGS", or "DEBITCARD"
            "title": "John Testman",
            "bankName": "Bank of America", //name of the bank with whom the account is associated
            "isOwn": true,
            "countryCode": "USA", //3-letter country code, ISO 3166-1 alpha-3 format
            "currency": "USD", //3-letter ISO alphabetic code to identify the currency
            "isVerified": true, //boolean, true if the account has already been verified
            "isSyncedToServer": true, //boolean, true if the account is synced to the server
            "accountNumberMasked": "**********1234" //account number that has been masked except for the last 4 digits
        },
        {
            "AFiExternalAccountId": "qweealasgjrtselpavxaxxrjx", //external account ID in the ampliFi
            "backOfficeId": "evolve",
            "backOfficeName": "evolve",
            "dtsCreated": "2022-11-22T16:55:23.174Z", //date the account was added to ampliFi
            "dtsModified": "2022-11-22T16:55:23.174Z", //date of last modification to the account in ampliFi
            "isActive": true, //boolean, true if the account is active
            "isEnabled": true, //boolean, true if the account is enabled
            "isPullAllowed": true, //boolean, true if funds can be pulled from the account
            "isPushAllowed": true, //boolean, true if funds can be pushed to the account
            "comment": "External savings account", //brief description of account
            "accountNumber": "12345678901235", //account number
            "routingNumber": "123456789", //a US ABA account routing number
            "type": "SAVINGS", //type of account, "CHECKING", "SAVINGS", or "DEBITCARD"
            "title": "John Testman",
            "bankName": "Bank of America", //name of the bank with whom the account is associated
            "isOwn": true,
            "countryCode": "USA", //3-letter country code, ISO 3166-1 alpha-3 format
            "currency": "USD", //3-letter ISO alphabetic code to identify the currency
            "isVerified": true, //boolean, true if the account has already been verified
            "name": "Account name update", //name of account
            "isSyncedToServer": true, //boolean, true if the account is synced to the server
            "accountNumberMasked": "**********1234" //account number that has been masked except for the last 4 digits
        }
    ],
    "autofunding": {
        "isSyncedToServer": true
    },
    "success": true //Success
}

200 (HTTP response status code) -- Success, external accounts currently registered for user listed

In this example, the specified user has an external debit card registered.

{
    "externalAccounts": [
        {
            "AFiExternalAccountId": "ealask9c7fifprjrulkcmw", //external account ID in the ampliFi system
            "backOfficeId": "tabapayBOIS",
            "backOfficeName": "tabapayBOIS",
            "dtsCreated": "2022-11-22T18:39:10.347Z", //date the account was added to ampliFi
            "dtsModified": "2022-11-22T18:39:10.347Z", //date of last modification to the account in ampliFi
            "isActive": true, //boolean, true if the account is active
            "isEnabled": true, //boolean, true if the account is enabled
            "isPullAllowed": true, //boolean, true if funds can be pulled from the account
            "isPushAllowed": true, //boolean, true if funds can be pushed to the account
            "isVerified": true, //boolean, true if the account has already been verified
            "accountNumberMasked": "1...2345", //account number that has been masked except for the last 4 digits
            "panMasked": "1...2345", //debit card primary account number (PAN) that has been masked except for the last 4 digits
            "dtsExpires": "2025-12-01T04:59:59.999Z", //expiration date of debit card in ampliFi system
            "expiryYYYYMM": "202511", //expiration date of debit card
            "name_on_card": "John Testman", //By default ${firstName} ${lastName}
            "type": "DEBITCARD", //type of account, "CHECKING", "SAVINGS", or "DEBITCARD"
            "title": "John Testman", //By default ${firstName} ${lastName}
            "currency": "USD", //3-letter ISO alphabetic code to identify the currency
            "countryCode": "US", //2-letter country code
            "comment": "External debit card account", //brief description of account
            "isSyncedToServer": true //boolean, true if the account is synced to the server
        }
    ],
    "autofunding": {
        "isSyncedToServer": true
    },
    "success": true //Success
}

200 (HTTP response status code) -- Success, external accounts currently registered for user listed

In this example, the specified user has no external accounts registered yet so an empty array is returned.

{
    "externalAccounts": [], //The specified user has no external accounts registered yet so an empty array is returned.
    "autofunding": {
        "isSyncedToServer": true
    },
    "success": true //Success
}

Back to Top

Verify

Request method and URL:

POST /externalaccount/verify

Description:

This method verifies an external account. It checks if the account is already verified, or calls the backoffice API for verification. The ampliFi external account ID ("AFiExternalAccountId") must be passed in the request body.

Required Properties Description Schema Example Values
AFiExternalAccountId The external account ID in ampliFi String "qweealasn0avuygieaupmevow"

Request headers:

{
    "Content-Type": "application/json",
    "token": "a long random string" //Authorization token received from /token request
}

Request body example:

{
  "AFiExternalAccountId": "qweealasn0avuygieaupmevow"
}

Possible responses:

200 (HTTP response status code) -- Success, the account is verified

{
    "success": true
}

If the request is unsuccessful, no JSON response body will be returned.

Back to Top

Pull

Request method and URL:

POST /externalaccount/pull

Description:

This method pulls a specified amount of money from the external account. The user ID and the external account ID must be specified in the request body, along with the amount and currency.

The amount is deposited in a specified account or in the user's main account. It may be subject to a pre-specified maximum and minimum. Optionally, the pull may be labeled as recurring, to indicate that it is part of a repeating series.

The request will be presented for fulfillment to a suitable backoffice. If the external account is already linked to a backoffice, this will be used. Otherwise a backoffice will be selected if possible.

Required Properties Description Schema Example Values
AFiExternalAccountId The external account ID in ampliFi String "ealasjyfdqnenqrvcucqad"
AFiUserId The user ID in ampliFi String "qweaurl8kgtlv9pc"
amount The amount of funds to be transferred, (Min: 20, Max: 200) Number 100.00
currency 3-letter ISO alphabetic code to identify the currency String "USD"
Optional Properties Description Schema Example Values
AFiAccountId The receiving account ID in ampliFi, default is the user's main account String "qwegal8kgtmysmels"
account The receiving account object Object {//receiving account properties}
AFiEARequestId The external account request ID in ampliFi String
isRecurring Indicates whether this transaction will be recurring Boolean true or false

Request headers:

{
    "Content-Type": "application/json",
    "token": "a long random string" //Authorization token received from /token request
}

Request body example:

{
  "AFiExternalAccountId": "ealasjyfdqnenqrvcucqad", //external account ID in the ampliFi system
  "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
  "amount": 100, //the amount of funds to be transferred
  "currency": USD //3-letter currency code
  "isRecurring": false // optional, indicates whether this will be a recurring transaction, true/false
}

Possible responses:

200 (HTTP response status code) -- Success

{
    "success": true
}

Back to Top

Push

Request method and URL:

POST /externalaccount/push

Description:

This method pushes a specified amount of money to the specified external account (from the account corresponding to AFiAccountId or the user's main account). The user ID ("AFiUserId") and the external account ID ("AFiExternalAccountId") must be specified in the request body, along with the amount and currency.

The amount is deducted from the AFiAccountId account (or user's main account if not specified) and is deposited in the AFiExternalAccountId account. It may be subject to a pre-specified maximum and minimum. Optionally, the push may be labeled as recurring, to indicate that it is part of a repeating series.

The request will be presented for fulfillment to a suitable backoffice. If the external account is already linked to a backoffice, this will be used. Otherwise a backoffice will be selected if possible.

Required Properties Description Schema Example Values
AFiExternalAccountId The external account ID in ampliFi String "ealasjyfdqnenqrvcucqad"
AFiUserId The user ID in ampliFi String "qweaurl8kgtlv9pc"
amount The amount of funds to be transferred, (Min: 0, Max: 1001) Number 1.01
currency 3-letter ISO alphabetic code to identify the currency String "USD"
Optional Properties Description Schema Example Values
AFiAccountId The sending account ID in ampliFi, default is the user's main account String "qwegal8kgtmysmels"
account The sending account object Object {//sending account properties}
AFiEARequestId The external account request ID in ampliFi String
isRecurring Indicates whether this transaction will be recurring Boolean true or false

Request headers:

{
    "Content-Type": "application/json",
    "token": "a long random string" //Authorization token received from /token request
}

Request body example:

{
    "AFiExternalAccountId": "ealasjyfdqnenqrvcucqad", //external account ID in the ampliFi system
    "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
    "amount": 1.00, //the amount of funds to be transferred
    "currency": "USD" //3-letter currency code
}

Possible responses:

200 (HTTP response status code) -- Success

{
    "success": true
}

Back to Top

Linktoken

Request method and URL:

POST /externalaccount/linktoken

Description:

Generate a link token to identify the external account. The token is fetched from a suitable backoffice.

Required Properties Description Schema Example Values
AFiUserId The user ID in ampliFi String "qweaurl8kgtlv9pc"

Request body example:

{   
  "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
}

Possible responses:

200 (HTTP response status code) -- Success

{
    "success": true,
    "linkToken": "link-production-b66f78d5-2f99-42a9-b2be-0106d2a6233d"
}

Back to Top

Autofunding

Request method and URL:

POST /externalaccount/autofunding

Description:

Setup or modify autofunding for this account. Autofunding transfers a set amount from the external account on a regular schedule, or cadence. The transfer may be weekly, monthly, or when the user's account is low.

If cadence is "weekly", the optional "weekday" property specifies the day for the transfer. The default weekday is Sunday if not specified.

If cadence is "monthly", the "day" property is required to specify the day of the month for the transfer to occur. If the "day" property value is greater than 0 and less than or equal to the current day of the month, the date of the next transfer will be the specified day of the following month. If the "day" property value is greater than the current day of the month and less than or equal to the number of days in the current month, the date of the next transfer will be the specified day of the current month. If the "day" property value is greater than the total number of days in the current month, the date of the next transfer will be a certain number of days from the current date (where days from the current date = the value of "days" - the number of days in the current month). See the chart below for some examples of how the "day" value corresponds to the date of the next transfer.

Value of day property Current Month Current Day Current Year dtsNext Date of Next Transfer
0 November 22nd 2022 "2022-11-30T14:00:14.403Z" 2022-11-30
1 November 22nd 2022 "2022-12-01T14:00:18.229Z" 2022-12-01
5 November 22nd 2022 "2022-12-05T14:00:31.808Z" 2022-12-05
21 November 22nd 2022 "2022-12-21T14:00:06.122Z" 2022-12-21
22 November 22nd 2022 "2022-12-22T14:00:43.849Z" 2022-12-22
30 November 22nd 2022 "2022-11-30T14:00:00.981Z" 2022-11-30
31 November 22nd 2022 "2022-12-01T14:00:17.342Z" 2022-12-01
35 November 22nd 2022 "2022-12-05T14:00:34.368Z" 2022-12-05
50 November 22nd 2022 "2022-12-20T14:00:39.114Z" 2022-12-20
100 November 22nd 2022 "2023-02-08T14:00:58.911Z" 2023-02-08
500 November 22nd 2022 "2024-03-14T13:00:14.749Z" 2024-03-14

If cadence is "when_low", the "lowAmount" property specifies the low limit.

Required Properties Description Schema Example Values
AFiUserId The user ID in ampliFi String "qweaurl8kgtlv9pc"
AFiExternalAccountId The external account ID in ampliFi String "ealasjyfdqnenqrvcucqad"
cadence How often the account should be autofunded "String" "weekly", "monthly", or "when_low"
Optional Properties Description Schema Example Values
amount The amount of funds to be transferred each time the account is autofunded Number 100.00
currency 3-letter ISO alphabetic code to identify the currency String "USD"
weekday Used if cadence is "weekly" to specify the day for the transfer, default is "Sun" if not specified String "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat
day Required only if cadence is "monthly" to specify the day of the month for the transfer Number 15
lowAmount Used if cadence is "when_low" to indicate the threshold at which to top up the account Number 10.00

Request headers:

{
    "Content-Type": "application/json",
    "token": "a long random string" //Authorization token received from /token request
}

Request body examples:

In this example, the cadence is "weekly" so "weekday" will specify the day of the week that the account should be autofunded.

{   
    "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
    "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
    "cadence": "weekly", //how often the account should be autofunded ("weekly", "monthly", or "when_low")
    "amount": 100, //the amount of funds to be transferred each time the account is autofunded
    "currency": "USD", //3-letter ISO alphabetic code to identify the currency
    "weekday": "Sat" //day of the week to autofund, used when cadence="weekly"
}

In this example, the cadence is "monthly" so "day" will specify the day of the month that the account should be autofunded.

{   
    "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
    "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
    "cadence": "monthly", //how often the account should be autofunded ("weekly", "monthly", or "when_low")
    "amount": 100, //the amount of funds to be transferred each time the account is autofunded
    "currency": "USD", //3-letter ISO alphabetic code to identify the currency
    "day": 5 //day of the month to autofund, used when cadence="monthly"
}

In this example, the cadence is "when_low" so "lowAmount" will specify the threshold at which the account should be autofunded.

{   
    "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
    "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
    "cadence": "when_low", //how often the account should be autofunded ("weekly", "monthly", or "when_low")
    "amount": 100, //the amount of funds to be transferred each time the account is autofunded
    "currency": "USD", //3-letter ISO alphabetic code to identify the currency
    "lowAmount": 10.00 //the threshold at which the account should be topped up, used when cadence="when_low"
}

Possible responses:

200 (HTTP response status code) -- Success, cadence is "weekly"

{
    "success": true, //Success
    "autofunding": {
        "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
        "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
        "amount": 100, //the amount of funds to be transferred each time the account is autofunded
        "currency": "USD", //3-letter ISO alphabetic code to identify the currency
        "cadence": "weekly", //how often the account should be autofunded ("weekly", "monthly", or "when_low")
        "dtsModified": "2022-11-23T01:02:04.108Z", //date that autofunding was modified
        "weekday": "Sat", //day of the week to autofund, used when cadence="weekly"
        "dtsNext": "2022-11-26T14:00:04.108Z", //date that the next autofunding transfer will occur
        "isSyncedToServer": true
    }
}

200 (HTTP response status code) -- Success, cadence is "monthly"

{
    "success": true, //Success
    "autofunding": {
        "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
        "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
        "amount": 100, //the amount of funds to be transferred each time the account is autofunded
        "currency": "USD", //3-letter ISO alphabetic code to identify the currency
        "cadence": "monthly", //how often the account should be autofunded ("weekly", "monthly", or "when_low")
        "dtsModified": "2022-11-23T01:32:51.760Z", //date that autofunding was modified
        "day": 5, //day of the month to autofund, used when cadence="monthly"
        "dtsNext": "2022-12-05T14:00:51.760Z", //date that the next autofunding transfer will occur
        "isSyncedToServer": true
    }
}

200 (HTTP response status code) -- Success, cadence is "when_low"

{
    "success": true, //Success
    "autofunding": {
        "AFiUserId": "qweaurl8kgtlv9pc", //user ID in the ampliFi system
        "AFiExternalAccountId": "qweealasg9yq6ctybidgitimu", //external account ID in the ampliFi system
        "amount": 100, //the amount of funds to be transferred each time the account is autofunded
        "currency": "USD", //3-letter ISO alphabetic code to identify the currency
        "cadence": "when_low", //how often the account should be autofunded ("weekly", "monthly", or "when_low")
        "dtsModified": "2022-11-23T01:48:00.312Z", //date that autofunding was modified
        "lowAmount": 10, //the threshold at which the account should be topped up, used when cadence="when_low"
        "dtsNext": "2022-11-23T01:48:00.312Z", //date that the next autofunding transfer will occur
        "isSyncedToServer": true
    }
}

Back to Top