Skip to main content

UsBankAccount

US Bank Account, that might support ACH, RFP, RTP or Wire Transfer.

Required Fields:

  • accountNumber
  • routingNumber

Account holder name might be required for name matching.

    id string

    The instrument id

    customerId string

    The customer to which this instrument belongs.

    instrumentType

    string

    required

    Possible values: [CARD, SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

    Represents the type of the instrument.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    CCI_BANK_ACCOUNTCCI Bank account
    CARDCard
    pan stringrequired

    Card number.

    cardHolderName string

    Possible values: <= 160 characters

    Card holder name.

    bankName string

    The bank name.

    expiryDate

    object

    required

    Card expiry date.

    year integerrequired
    month integerrequired
    cardScheme CardScheme (string)

    Possible values: [VISA, MC]

    Card scheme information.

    • VISA - VISA
    • MC - Mastercard The scheme is derived from the card PAN.
    description string

    Possible values: <= 20 characters

    Name to be associated with the card.

    externallyVerified booleandeprecated

    Is the instrument externally verified. The property is not returned by the API anymore.

    status string

    Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

    The instrument status.

    creationTime date-time

    Represents RFC 3339, section 5.6 date-time.

    accountHolderName string

    Possible values: <= 100 characters

    This is the name of the customer or company that owns the bank account. As per regulations, the Wallet holder and bank account holder must be the same.

    accountNumber stringrequired

    Possible values: >= 4 characters and <= 17 characters

    The bank account number.

    routingNumber stringrequired

    Possible values: >= 9 characters and <= 9 characters

    For USD accounts, this is the 9-digit routing number of the bank.

    bankName string

    The bank name.

    accountType string

    Possible values: [SAVINGS, CHECKING, LOAN]

    The account type.