Skip to main content
GET
/
payment-accounts
List payment accounts
curl --request GET \
  --url https://api.fernhq.com/payment-accounts \
  --header 'Authorization: Bearer <token>'
{
  "paymentAccounts": [
    {
      "paymentAccountId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
      "paymentAccountType": "EXTERNAL_BANK_ACCOUNT",
      "nickname": "Savings Account",
      "createdAt": "2023-11-07T05:31:56Z",
      "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
      "paymentAccountStatus": "ACTIVE",
      "externalBankAccount": {
        "bankAccountType": "CHECKING",
        "bankAccountOwnerName": "John Doe",
        "bankAccountOwnerEmail": "john@exmaple.com",
        "bankName": "Chase Bank",
        "bankAccountCurrency": {
          "label": "<string>"
        },
        "bankAccountMask": "***6789",
        "bankAccountPaymentMethod": "<any>",
        "bankAccountNumber": "12346789",
        "routingNumber": "11110000",
        "wireRoutingNumber": "026009593",
        "iban": "GB29NWBK60161331926819",
        "bicSwift": "SMCOGB2LXXX",
        "sortCode": "123456",
        "transitNumber": "12345",
        "institutionNumber": "111",
        "bsbNumber": "123-456",
        "ifscCode": "IFSC0001234",
        "clabeNumber": "123456789012345678",
        "bankCode": "123456",
        "branchCode": "12345",
        "cnapsCode": "123456789",
        "nubanNumber": "123456789012",
        "pixCode": "123456789",
        "clearingCode": "123456",
        "taxNumber": "123456789"
      },
      "fernAutoFiatAccount": {
        "bankAccountOwnerName": "John Doe",
        "bankName": "Chase Bank",
        "bankAccountCurrency": {
          "label": "<string>"
        },
        "bankAccountPaymentMethods": [
          "ACH",
          "WIRE"
        ],
        "bankAccountNumber": "12346789",
        "routingNumber": "12346789",
        "iban": "GB29NWBK60161331926819",
        "bicSwift": "SMCOGB2LXXX",
        "destinationPaymentAccountId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
        "destinationCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "destinationPaymentMethod": "BASE"
      },
      "fernFiatAccount": {
        "bankAccountOwnerName": "John Doe",
        "bankName": "Chase Bank",
        "bankAccountCurrency": {
          "label": "<string>"
        },
        "bankAccountPaymentMethods": [
          "ACH",
          "WIRE"
        ],
        "bankAccountNumber": "12346789",
        "routingNumber": "12346789",
        "iban": "GB29NWBK60161331926819",
        "bicSwift": "SMCOGB2LXXX",
        "sortCode": "123456",
        "transitNumber": "12345",
        "institutionNumber": "111",
        "bsbNumber": "123-456",
        "clabeNumber": "123456789012345678",
        "bankCode": "123456",
        "cnapsCode": "123456789",
        "clearingCode": "123456"
      },
      "externalCryptoWallet": {
        "cryptoWalletType": "EVM",
        "chain": "BASE",
        "address": "0x1234567890123456789012345678901234567890"
      },
      "fernCryptoWallet": {
        "cryptoWalletType": "EVM",
        "address": "0x1234567890123456789012345678901234567890"
      },
      "isThirdParty": false
    }
  ],
  "nextPageToken": "xyz"
}

Authorizations

​
Authorization
string
header
required

To authenticate server-side requests

Query Parameters

​
pageToken
string

Token for forward pagination

​
pageSize
integer
default:10

Number of items per page (default: 10, max: 100)

Required range: x >= 1
​
customerId
string<uuid>
required

Customer to list payment accounts for

Response

Default Response

​
paymentAccounts
Payment Accounts · object[]

Retrieved payment accounts

​
nextPageToken
string

Page token to use to fetch next page

Example:

"xyz"