Struct BankAccountUs 

pub struct BankAccountUs {
    pub account_number: FiatAccountNumber,
    pub account_type: BankAccountUsAccountType,
    pub bank_address: Option<String>,
    pub bank_name: String,
    pub beneficiary_name: String,
    pub currency: BankAccountUsCurrency,
    pub reference_code: Option<String>,
    pub routing_number: BankAccountUsRoutingNumber,
    pub supported_rails: Vec<DepositDestinationPaymentRail>,
}

A US bank account identified by ABA routing number and account number.

JSON schema

{
 "description": "A US bank account identified by ABA routing number and account number.",
 "examples": [
   {
     "accountNumber": "123456789",
     "accountType": "us_bank",
     "bankAddress": "399 Park Avenue, New York, NY 10022",
     "bankName": "Citibank N.A.",
     "beneficiaryName": "John Smith",
     "currency": "usd",
     "routingNumber": "987654321",
     "supportedRails": [
       "ach",
       "fedwire"
     ]
   }
 ],
 "type": "object",
 "required": [
   "accountNumber",
   "accountType",
   "bankName",
   "beneficiaryName",
   "currency",
   "routingNumber",
   "supportedRails"
 ],
 "properties": {
   "accountNumber": {
     "$ref": "#/components/schemas/FiatAccountNumber"
   },
   "accountType": {
     "description": "The type of bank account, based on the account identification scheme (e.g., `us_bank`).",
     "examples": [
       "us_bank"
     ],
     "type": "string",
     "enum": [
       "us_bank"
     ]
   },
   "bankAddress": {
     "description": "The address of the bank. Present when required by the receiving institution.",
     "examples": [
       "399 Park Avenue, New York, NY 10022"
     ],
     "type": "string"
   },
   "bankName": {
     "description": "The name of the bank holding the account.",
     "examples": [
       "Citibank N.A."
     ],
     "type": "string"
   },
   "beneficiaryName": {
     "description": "The name of the account beneficiary.",
     "examples": [
       "John Smith"
     ],
     "type": "string"
   },
   "currency": {
     "description": "The fiat currency for the deposit destination.",
     "examples": [
       "usd"
     ],
     "type": "string",
     "enum": [
       "usd"
     ]
   },
   "referenceCode": {
     "description": "A reference code that must be included in the payment memo or reference field so the receiving institution can route the deposit to the correct account. Only present when required by the receiving institution.",
     "examples": [
       "CBAUSD1A2B3C4D"
     ],
     "type": "string"
   },
   "routingNumber": {
     "description": "The ABA routing number of the bank.",
     "examples": [
       "987654321"
     ],
     "type": "string",
     "pattern": "^[0-9]{9}$"
   },
   "supportedRails": {
     "description": "The payment rails this account can receive deposits on.",
     "examples": [
       [
         "ach",
         "fedwire"
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/DepositDestinationPaymentRail"
     }
   }
 }
}

Fields

account_number: FiatAccountNumber

account_type: BankAccountUsAccountType

The type of bank account, based on the account identification scheme (e.g., us_bank).

bank_address: Option<String>

The address of the bank. Present when required by the receiving institution.

bank_name: String

The name of the bank holding the account.

beneficiary_name: String

The name of the account beneficiary.

currency: BankAccountUsCurrency

The fiat currency for the deposit destination.

reference_code: Option<String>

A reference code that must be included in the payment memo or reference field so the receiving institution can route the deposit to the correct account. Only present when required by the receiving institution.

routing_number: BankAccountUsRoutingNumber

The ABA routing number of the bank.

supported_rails: Vec<DepositDestinationPaymentRail>

The payment rails this account can receive deposits on.

Implementations

impl BankAccountUs

pub fn builder() -> BankAccountUs

Trait Implementations

impl Clone for BankAccountUs

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BankAccountUs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BankAccountUs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&BankAccountUs> for BankAccountUs

fn from(value: &BankAccountUs) -> Self

Converts to this type from the input type.

impl From<BankAccountUs> for DepositDestinationFiat

fn from(value: BankAccountUs) -> Self

Converts to this type from the input type.

impl From<BankAccountUs> for BankAccountUs

fn from(value: BankAccountUs) -> Self

Converts to this type from the input type.

impl From<DepositDestinationFiat> for BankAccountUs

fn from(value: DepositDestinationFiat) -> Self

Converts to this type from the input type.

impl Serialize for BankAccountUs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<BankAccountUs> for BankAccountUs

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: BankAccountUs) -> Result<Self, ConversionError>

Performs the conversion.