Bank Accounts

Use this API to add, update and get bank accounts for an existing customer. Currently, only USD bank accounts with domestic ACH/wire routing numbers are supported.

Create a bank account

POSThttps://app.fernhq.com/api/v0/bank-accounts

Body

application/json

customerId*string

Unique identifier of the customer

Example: "03b7030f-6da1-4d76-9352-cdebd82112c8"

beneficiary*Beneficiary Information

Details about the bank account beneficiary

bankAccountInformation*Bank Account Information

Banking details including account numbers, routing numbers, and account type

Response

200400404500

Bank account created successfully

Body

application/json

id*string

Unique identifier of the bank account

Example: "072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

accountMask*string

Last 4 digits of the account number

Example: "6789"

bankName*string

Name of the bank

Example: "Chase Bank"

beneficiary*object

Basic beneficiary information

accountType*Account Type

The type of bank account

checkingsavings

Request

JavaScriptCurlPython

const response = await fetch('https://app.fernhq.com/api/v0/bank-accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
      "beneficiary": {
        "name": "John Doe",
        "address": {
          "addressLine1": "123 Main Street",
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94105",
          "country": "US"
        },
        "type": "personal"
      },
      "bankAccountInformation": {
        "accountNumber": "000123456789",
        "accountType": "checking",
        "bankName": "Chase Bank"
      }
    }),
});
const data = await response.json();

Response

200400404500

{
  "id": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
  "accountMask": "6789",
  "bankName": "Chase Bank",
  "beneficiary": {
    "type": "personal",
    "name": "text"
  },
  "accountType": "checking"
}

Update bank account details

PATCHhttps://app.fernhq.com/api/v0/bank-accounts/{bankAccountId}

Path parameters

bankAccountId*string

Unique identifier of the bank account

Example: "072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

Body

application/json

customerId*string

Unique identifier of the customer

Example: "03b7030f-6da1-4d76-9352-cdebd82112c8"

beneficiaryobject

Updated beneficiary information - all fields are optional

bankAccountInformationobject

Updated bank account information - all fields are optional

Response

200404

Bank account updated successfully

Body

application/json

id*string

Unique identifier of the bank account

Example: "072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

accountMask*string

Last 4 digits of the account number

Example: "6789"

bankName*string

Name of the bank

Example: "Chase Bank"

beneficiary*object

Basic beneficiary information

accountType*Account Type

The type of bank account

checkingsavings

Request

JavaScriptCurlPython

const response = await fetch('https://app.fernhq.com/api/v0/bank-accounts/{bankAccountId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8"
    }),
});
const data = await response.json();

Response

200404

{
  "id": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
  "accountMask": "6789",
  "bankName": "Chase Bank",
  "beneficiary": {
    "type": "personal",
    "name": "text"
  },
  "accountType": "checking"
}

Get bank account details

GEThttps://app.fernhq.com/api/v0/bank-accounts/{bankAccountId}

Path parameters

bankAccountId*string

Unique identifier of the bank account

Example: "072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

Response

200404

Bank account details retrieved successfully

Body

application/json

id*string

Unique identifier of the bank account

Example: "072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

accountMask*string

Last 4 digits of the account number

Example: "6789"

bankName*string

Name of the bank

Example: "Chase Bank"

beneficiary*object

Basic beneficiary information

accountType*Account Type

The type of bank account

checkingsavings

Request

JavaScriptCurlPython

const response = await fetch('https://app.fernhq.com/api/v0/bank-accounts/{bankAccountId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
  "accountMask": "6789",
  "bankName": "Chase Bank",
  "beneficiary": {
    "type": "personal",
    "name": "text"
  },
  "accountType": "checking"
}

List bank accounts

GEThttps://app.fernhq.com/api/v0/bank-accounts

Query parameters

Response

200403

Bank account details retrieved successfully

Body

application/json

bankAccountsBank Accounts

Retrieved bank accounts

nextPageTokenstring

Page token to use to fetch next page

Example: "xyz"

Request

JavaScriptCurlPython

const response = await fetch('https://app.fernhq.com/api/v0/bank-accounts?customerId=072a8b7b-38c7-429a-a6cf-35dae7f2fb77', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "bankAccounts": [
    {
      "id": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
      "accountMask": "6789",
      "bankName": "Chase Bank",
      "beneficiary": {
        "type": "personal",
        "name": "text"
      },
      "accountType": "checking"
    }
  ],
  "nextPageToken": "xyz"
}