List payment accounts

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

List Payment Accounts Response

Response schema for listing payment accounts

paymentAccounts

Payment Accounts · object[]

Retrieved payment accounts

Show child attributes

paymentAccounts.paymentAccountId

string<uuid>

required

The id of the payment account

paymentAccounts.paymentAccountType

enum<string>

required

Type of payment account to create

Available options:

FERN_CRYPTO_WALLET,

EXTERNAL_CRYPTO_WALLET,

EXTERNAL_BANK_ACCOUNT,

FERN_AUTO_FIAT_ACCOUNT,

FERN_FIAT_ACCOUNT

paymentAccounts.paymentAccountStatus

enum<string>

required

The status of the payment account

Available options:

PENDING,

ACTIVE,

DEACTIVATED

paymentAccounts.nickname

string

Nickname for customer to use for the payment account

paymentAccounts.createdAt

string<date-time>

ISO timestamp when this transaction was created

paymentAccounts.customerId

string<uuid>

The id of the customer this payment account belongs to

paymentAccounts.externalBankAccount

External Bank Account Response Schema · object

Response schema for external bank accounts

Show child attributes

paymentAccounts.externalBankAccount.bankAccountType

enum<string>

required

The type of bank account

Available options:

CHECKING,

SAVINGS

Example:

"CHECKING"

paymentAccounts.externalBankAccount.bankAccountOwnerName

string

required

The name of the owner of this bank account

Minimum string length: 1

Example:

"John Doe"

paymentAccounts.externalBankAccount.bankAccountOwnerEmail

string<email>

required

The emil of the owner of this bank account

Example:

"[email protected]"

paymentAccounts.externalBankAccount.bankName

string

required

The bank name

Minimum string length: 1

Example:

"Chase Bank"

paymentAccounts.externalBankAccount.bankAccountCurrency

object

required

The currency supported by the bank account

Show child attributes

paymentAccounts.externalBankAccount.bankAccountCurrency.label

string

required

paymentAccounts.externalBankAccount.bankAccountMask

string

required

The mask of this bank accounts account number

Example:

"***6789"

paymentAccounts.externalBankAccount.bankAccountPaymentMethod

enum<string>

required

The payment method bank account works with

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT

Example:

"ACH"

paymentAccounts.externalBankAccount.bankAccountNumber

string

The bank account's account number

Example:

"12346789"

paymentAccounts.externalBankAccount.routingNumber

string

The bank account's routing number if applicable

Example:

"11110000"

paymentAccounts.externalBankAccount.wireRoutingNumber

string

The bank account's wire routing number (US only)

Example:

"026009593"

paymentAccounts.externalBankAccount.iban

string

International Bank Account Number

Example:

"GB29NWBK60161331926819"

paymentAccounts.externalBankAccount.bicSwift

string

SWIFT/BIC code for international transfers

Example:

"SMCOGB2LXXX"

paymentAccounts.externalBankAccount.sortCode

string

Sort code (used in the UK)

Example:

"123456"

paymentAccounts.externalBankAccount.transitNumber

string

Transit number (used in Canada)

Example:

"12345"

paymentAccounts.externalBankAccount.institutionNumber

string

Institution number (used in Canada)

Example:

"111"

paymentAccounts.externalBankAccount.bsbNumber

string

BSB number (used in Australia)

Example:

"123-456"

paymentAccounts.externalBankAccount.ifscCode

string

IFSC code (used in India)

Example:

"IFSC0001234"

paymentAccounts.externalBankAccount.clabeNumber

string

CLABE number (used in Mexico)

Example:

"123456789012345678"

paymentAccounts.externalBankAccount.bankCode

string

Bank code (country-specific)

Example:

"123456"

paymentAccounts.externalBankAccount.branchCode

string

Branch code (country-specific)

Example:

"12345"

paymentAccounts.externalBankAccount.cnapsCode

string

CNAPS code (used in China)

Example:

"123456789"

paymentAccounts.externalBankAccount.nubanNumber

string

NUBAN number (used in Nigeria)

Example:

"123456789012"

paymentAccounts.externalBankAccount.pixCode

string

PIX key (used in Brazil)

Example:

"123456789"

paymentAccounts.externalBankAccount.clearingCode

string

Clearing code (used in Hong Kong)

Example:

"123456"

paymentAccounts.externalBankAccount.taxNumber

string

Tax identification number (CPF/CNPJ)

Example:

"123456789"

paymentAccounts.fernAutoFiatAccount

Fern Auto Fiat Account Response Schema · object

Response schema for Fern auto fiat accounts

Show child attributes

paymentAccounts.fernAutoFiatAccount.bankAccountOwnerName

string

required

The name of the owner of this bank account

Minimum string length: 1

Example:

"John Doe"

paymentAccounts.fernAutoFiatAccount.bankName

string

required

The bank name

Minimum string length: 1

Example:

"Chase Bank"

paymentAccounts.fernAutoFiatAccount.bankAccountCurrency

object

required

The currency supported by the bank account

Show child attributes

paymentAccounts.fernAutoFiatAccount.bankAccountCurrency.label

string

required

paymentAccounts.fernAutoFiatAccount.bankAccountPaymentMethods

enum<string>[]

required

The payment methods bank account works with

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT

Example:

["ACH", "WIRE"]

paymentAccounts.fernAutoFiatAccount.destinationPaymentAccountId

string

required

The payment account id funds will be forwarded to

Example:

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

paymentAccounts.fernAutoFiatAccount.destinationCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

paymentAccounts.fernAutoFiatAccount.destinationCurrency.label

string

required

paymentAccounts.fernAutoFiatAccount.destinationCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

paymentAccounts.fernAutoFiatAccount.destinationCurrency.contractAddress

string

paymentAccounts.fernAutoFiatAccount.destinationCurrency.currencyDecimals

number

Example:

{
  "label": "USDC",
  "chain": "ETHEREUM",
  "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
  "currencyDecimals": 18
}

paymentAccounts.fernAutoFiatAccount.bankAccountNumber

string

The bank account's account number

Example:

"12346789"

paymentAccounts.fernAutoFiatAccount.routingNumber

string

The bank account's routing number if applicable

Example:

"12346789"

paymentAccounts.fernAutoFiatAccount.iban

string

International Bank Account Number

Example:

"GB29NWBK60161331926819"

paymentAccounts.fernAutoFiatAccount.bicSwift

string

SWIFT/BIC code for international transfers

Example:

"SMCOGB2LXXX"

paymentAccounts.fernAutoFiatAccount.destinationPaymentMethod

enum<string>

The payment method for the destination account

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

Example:

"BASE"

paymentAccounts.fernFiatAccount

Fern Fiat Account Response Schema · object

Response schema for Fern fiat accounts

Show child attributes

paymentAccounts.fernFiatAccount.bankAccountOwnerName

string

The name of the owner of this bank account

Minimum string length: 1

Example:

"John Doe"

paymentAccounts.fernFiatAccount.bankName

string

The bank name

Minimum string length: 1

Example:

"Chase Bank"

paymentAccounts.fernFiatAccount.bankAccountCurrency

object

The currency supported by the bank account

Show child attributes

paymentAccounts.fernFiatAccount.bankAccountCurrency.label

string

required

paymentAccounts.fernFiatAccount.bankAccountPaymentMethods

enum<string>[]

The payment methods bank account works with

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT

Example:

["ACH", "WIRE"]

paymentAccounts.fernFiatAccount.bankAccountNumber

string

The bank account's account number

Example:

"12346789"

paymentAccounts.fernFiatAccount.routingNumber

string

The bank account's routing number if applicable

Example:

"12346789"

paymentAccounts.fernFiatAccount.iban

string

International Bank Account Number

Example:

"GB29NWBK60161331926819"

paymentAccounts.fernFiatAccount.bicSwift

string

SWIFT/BIC code for international transfers

Example:

"SMCOGB2LXXX"

paymentAccounts.fernFiatAccount.sortCode

string

Sort code (used in the UK)

Example:

"123456"

paymentAccounts.fernFiatAccount.transitNumber

string

Transit number (used in Canada)

Example:

"12345"

paymentAccounts.fernFiatAccount.institutionNumber

string

Institution number (used in Canada)

Example:

"111"

paymentAccounts.fernFiatAccount.bsbNumber

string

BSB number (used in Australia)

Example:

"123-456"

paymentAccounts.fernFiatAccount.clabeNumber

string

CLABE number (used in Mexico)

Example:

"123456789012345678"

paymentAccounts.fernFiatAccount.bankCode

string

Bank code (country-specific)

Example:

"123456"

paymentAccounts.fernFiatAccount.cnapsCode

string

CNAPS code (used in China)

Example:

"123456789"

paymentAccounts.fernFiatAccount.clearingCode

string

Clearing code (used in Hong Kong)

Example:

"123456"

paymentAccounts.externalCryptoWallet

External Crypto Wallet Response Schema · object

Response schema for external crypto wallets

Show child attributes

paymentAccounts.externalCryptoWallet.cryptoWalletType

enum<string>

required

The type of crypto wallet

Available options:

EVM,

SVM

Example:

"EVM"

paymentAccounts.externalCryptoWallet.chain

enum<string>

required

The chain the wallet is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

Example:

"BASE"

paymentAccounts.externalCryptoWallet.address

string

required

The address of the crypto wallet

Example:

"0x1234567890123456789012345678901234567890"

paymentAccounts.fernCryptoWallet

Fern Crypto Wallet Response Schema · object

Response schema for Fern crypto wallets

Show child attributes

paymentAccounts.fernCryptoWallet.cryptoWalletType

enum<string>

required

The type of crypto wallet

Available options:

EVM,

SVM

Example:

"EVM"

paymentAccounts.fernCryptoWallet.address

string

The address of the crypto wallet

Example:

"0x1234567890123456789012345678901234567890"

paymentAccounts.isThirdParty

boolean

default:false

Whether the payment account is a third-party account. Defaults to false.

nextPageToken

string

Page token to use to fetch next page

Customers

Transactions

Quotes

Payment Accounts

Automation Rules

Webhooks

Authorizations

Query Parameters

Response