Payment account created webhook

Authorizations

Authorization

string

header

required

To authenticate server-side requests

Body

application/json

Response schema for a payment account

paymentAccountId

string<uuid>

required

The id of the payment account

Example:

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

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

Example:

"EXTERNAL_BANK_ACCOUNT"

paymentAccountStatus

enum<string>

required

The status of the payment account

Available options:

PENDING,

ACTIVE,

DEACTIVATED

Example:

"ACTIVE"

nickname

string

Nickname for customer to use for the payment account

Example:

"Savings Account"

createdAt

string<date-time>

ISO timestamp when this transaction was created

customerId

string<uuid>

The id of the customer this payment account belongs to

Example:

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

externalBankAccount

External Bank Account Response Schema · object

Response schema for external bank accounts

Show child attributes

externalBankAccount.bankAccountType

enum<string>

required

The type of bank account

Available options:

CHECKING,

SAVINGS

Example:

"CHECKING"

externalBankAccount.bankAccountOwnerName

string

required

The name of the owner of this bank account

Minimum string length: 1

Example:

"John Doe"

externalBankAccount.bankAccountOwnerEmail

string<email>

required

The emil of the owner of this bank account

Example:

"[email protected]"

externalBankAccount.bankName

string

required

The bank name

Minimum string length: 1

Example:

"Chase Bank"

externalBankAccount.bankAccountCurrency

object

required

The currency supported by the bank account

Show child attributes

externalBankAccount.bankAccountCurrency.label

string

required

externalBankAccount.bankAccountMask

string

required

The mask of this bank accounts account number

Example:

"***6789"

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"

externalBankAccount.bankAccountNumber

string

The bank account's account number

Example:

"12346789"

externalBankAccount.routingNumber

string

The bank account's routing number if applicable

Example:

"11110000"

externalBankAccount.wireRoutingNumber

string

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

Example:

"026009593"

externalBankAccount.iban

string

International Bank Account Number

Example:

"GB29NWBK60161331926819"

externalBankAccount.bicSwift

string

SWIFT/BIC code for international transfers

Example:

"SMCOGB2LXXX"

externalBankAccount.sortCode

string

Sort code (used in the UK)

Example:

"123456"

externalBankAccount.transitNumber

string

Transit number (used in Canada)

Example:

"12345"

externalBankAccount.institutionNumber

string

Institution number (used in Canada)

Example:

"111"

externalBankAccount.bsbNumber

string

BSB number (used in Australia)

Example:

"123-456"

externalBankAccount.ifscCode

string

IFSC code (used in India)

Example:

"IFSC0001234"

externalBankAccount.clabeNumber

string

CLABE number (used in Mexico)

Example:

"123456789012345678"

externalBankAccount.bankCode

string

Bank code (country-specific)

Example:

"123456"

externalBankAccount.branchCode

string

Branch code (country-specific)

Example:

"12345"

externalBankAccount.cnapsCode

string

CNAPS code (used in China)

Example:

"123456789"

externalBankAccount.nubanNumber

string

NUBAN number (used in Nigeria)

Example:

"123456789012"

externalBankAccount.pixCode

string

PIX key (used in Brazil)

Example:

"123456789"

externalBankAccount.clearingCode

string

Clearing code (used in Hong Kong)

Example:

"123456"

externalBankAccount.taxNumber

string

Tax identification number (CPF/CNPJ)

Example:

"123456789"

fernAutoFiatAccount

Fern Auto Fiat Account Response Schema · object

Response schema for Fern auto fiat accounts

Show child attributes

fernAutoFiatAccount.bankAccountOwnerName

string

required

The name of the owner of this bank account

Minimum string length: 1

Example:

"John Doe"

fernAutoFiatAccount.bankName

string

required

The bank name

Minimum string length: 1

Example:

"Chase Bank"

fernAutoFiatAccount.bankAccountCurrency

object

required

The currency supported by the bank account

Show child attributes

fernAutoFiatAccount.bankAccountCurrency.label

string

required

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"]

fernAutoFiatAccount.destinationPaymentAccountId

string

required

The payment account id funds will be forwarded to

Example:

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

fernAutoFiatAccount.destinationCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

fernAutoFiatAccount.destinationCurrency.label

string

required

fernAutoFiatAccount.destinationCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

fernAutoFiatAccount.destinationCurrency.contractAddress

string

fernAutoFiatAccount.destinationCurrency.currencyDecimals

number

Example:

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

fernAutoFiatAccount.bankAccountNumber

string

The bank account's account number

Example:

"12346789"

fernAutoFiatAccount.routingNumber

string

The bank account's routing number if applicable

Example:

"12346789"

fernAutoFiatAccount.iban

string

International Bank Account Number

Example:

"GB29NWBK60161331926819"

fernAutoFiatAccount.bicSwift

string

SWIFT/BIC code for international transfers

Example:

"SMCOGB2LXXX"

fernAutoFiatAccount.destinationPaymentMethod

enum<string>

The payment method for the destination account

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

Example:

"BASE"

fernFiatAccount

Fern Fiat Account Response Schema · object

Response schema for Fern fiat accounts

Show child attributes

fernFiatAccount.bankAccountOwnerName

string

The name of the owner of this bank account

Minimum string length: 1

Example:

"John Doe"

fernFiatAccount.bankName

string

The bank name

Minimum string length: 1

Example:

"Chase Bank"

fernFiatAccount.bankAccountCurrency

object

The currency supported by the bank account

Show child attributes

fernFiatAccount.bankAccountCurrency.label

string

required

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"]

fernFiatAccount.bankAccountNumber

string

The bank account's account number

Example:

"12346789"

fernFiatAccount.routingNumber

string

The bank account's routing number if applicable

Example:

"12346789"

fernFiatAccount.iban

string

International Bank Account Number

Example:

"GB29NWBK60161331926819"

fernFiatAccount.bicSwift

string

SWIFT/BIC code for international transfers

Example:

"SMCOGB2LXXX"

fernFiatAccount.sortCode

string

Sort code (used in the UK)

Example:

"123456"

fernFiatAccount.transitNumber

string

Transit number (used in Canada)

Example:

"12345"

fernFiatAccount.institutionNumber

string

Institution number (used in Canada)

Example:

"111"

fernFiatAccount.bsbNumber

string

BSB number (used in Australia)

Example:

"123-456"

fernFiatAccount.clabeNumber

string

CLABE number (used in Mexico)

Example:

"123456789012345678"

fernFiatAccount.bankCode

string

Bank code (country-specific)

Example:

"123456"

fernFiatAccount.cnapsCode

string

CNAPS code (used in China)

Example:

"123456789"

fernFiatAccount.clearingCode

string

Clearing code (used in Hong Kong)

Example:

"123456"

externalCryptoWallet

External Crypto Wallet Response Schema · object

Response schema for external crypto wallets

Show child attributes

externalCryptoWallet.cryptoWalletType

enum<string>

required

The type of crypto wallet

Available options:

EVM,

SVM

Example:

"EVM"

externalCryptoWallet.chain

enum<string>

required

The chain the wallet is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

Example:

"BASE"

externalCryptoWallet.address

string

required

The address of the crypto wallet

Example:

"0x1234567890123456789012345678901234567890"

fernCryptoWallet

Fern Crypto Wallet Response Schema · object

Response schema for Fern crypto wallets

Show child attributes

fernCryptoWallet.cryptoWalletType

enum<string>

required

The type of crypto wallet

Available options:

EVM,

SVM

Example:

"EVM"

fernCryptoWallet.address

string

The address of the crypto wallet

Example:

"0x1234567890123456789012345678901234567890"

isThirdParty

boolean

default:false

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

Example:

false

Response

200

Acknowledged

Customers

Transactions

Quotes

Payment Accounts

Automation Rules

Webhooks

Authorizations

Body

Response