Payment Accounts

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

Create payment account

post

Create an account for a customer

Authorizations

Body

paymentAccountTypestring · enumrequired

Available options:

customerIdstringrequired

nicknamestringoptional

externalBankAccountobjectoptional

externalCryptoWalletobjectoptional

fernCryptoWalletobjectoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.fernhq.com/payment-accounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "paymentAccountType": "FERN_CRYPTO_WALLET",
    "customerId": "text",
    "nickname": "text",
    "externalBankAccount": {
      "accountNumber": "text",
      "bankName": "text",
      "bankAccountCurrency": "text",
      "bankAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "country": "text"
      },
      "bankAccountType": "CHECKING",
      "bankAccountOwner": {
        "email": "text",
        "firstName": "text",
        "lastName": "text",
        "businessName": "text",
        "address": {
          "addressLine1": null,
          "addressLine2": null,
          "city": null,
          "state": null,
          "postalCode": null,
          "country": null
        },
        "type": "PERSONAL"
      },
      "achRoutingNumber": "text",
      "wireRoutingNumber": "text"
    },
    "externalCryptoWallet": {
      "cryptoWalletType": "EVM",
      "chain": "arbitrum",
      "address": "text"
    },
    "fernCryptoWallet": {
      "cryptoWalletType": "EVM"
    }
  }'

201

400

401

403

404

500

201

{
  "paymentAccountId": "text",
  "paymentAccountType": "FERN_CRYPTO_WALLET",
  "nickname": "text",
  "createdAt": "2025-04-03T04:04:01.565Z",
  "externalBankAccount": {
    "bankAccountType": "CHECKING",
    "bankAccountOwnerName": "text",
    "bankAccountOwnerEmail": "text",
    "bankName": "text",
    "bankAccountCurrency": "text",
    "bankAccountMask": "text"
  },
  "bankAccountFormLink": "text",
  "externalCryptoWallet": {
    "cryptoWalletType": "EVM",
    "chain": "arbitrum",
    "address": "text"
  },
  "fernCryptoWallet": {
    "cryptoWalletType": "EVM",
    "address": "text"
  }
}

Default Response

Get payment account

get

Get details about a specific payment account

Authorizations

Path parameters

paymentAccountIdstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.fernhq.com/payment-accounts/{paymentAccountId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

500

200

{
  "paymentAccountId": "text",
  "paymentAccountType": "FERN_CRYPTO_WALLET",
  "nickname": "text",
  "createdAt": "2025-04-03T04:04:01.565Z",
  "externalBankAccount": {
    "bankAccountType": "CHECKING",
    "bankAccountOwnerName": "text",
    "bankAccountOwnerEmail": "text",
    "bankName": "text",
    "bankAccountCurrency": "text",
    "bankAccountMask": "text"
  },
  "externalCryptoWallet": {
    "cryptoWalletType": "EVM",
    "chain": "arbitrum",
    "address": "text"
  },
  "fernCryptoWallet": {
    "cryptoWalletType": "EVM",
    "address": "text"
  }
}

Default Response

List payment accounts

get

List all payment accounts

Authorizations

Query parameters

pageTokenstring | nullableoptional

pageSizenumber · min: 1 · max: 100optional

customerIdstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.fernhq.com/payment-accounts?customerId=text' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

500

200

{
  "paymentAccounts": [
    {
      "paymentAccountId": "text",
      "paymentAccountType": "FERN_CRYPTO_WALLET",
      "nickname": "text",
      "createdAt": "2025-04-03T04:04:01.565Z",
      "externalBankAccount": {
        "bankAccountType": "CHECKING",
        "bankAccountOwnerName": "text",
        "bankAccountOwnerEmail": "text",
        "bankName": "text",
        "bankAccountCurrency": "text",
        "bankAccountMask": "text"
      },
      "externalCryptoWallet": {
        "cryptoWalletType": "EVM",
        "chain": "arbitrum",
        "address": "text"
      },
      "fernCryptoWallet": {
        "cryptoWalletType": "EVM",
        "address": "text"
      }
    }
  ],
  "nextPageToken": "text"
}

Default Response