AccountDetails

Schema #/components/schemas/AccountDetails of contract 1.0.0-draft.14.

  • balanceId Uuidrequired

  • currency CurrencyCoderequired

  • rail stringrequired

    One of: "local", "swift"

  • accountHolderName stringrequired

  • iban string | null

  • bic string | null

    pattern ^[A-Z0-9]{8}([A-Z0-9]{3})?$

  • sortCode string | null

    pattern ^[0-9]{6}$

  • accountNumber string | null

  • routingCodes object

    Other national codes (ABA, BSB, IFSC …) keyed by scheme.

  • bankName string | null

  • bankAddress Address | null

  • reference string | null

    Reference the payer must quote (pooled accounts).

  • virtual booleanrequired

  • supportedRails array of Railrequired

  • provider ProviderIdread-only

    Fields of provider
  • status stringrequiredread-only

    pending until the partner has provisioned the account (identifiers may still be null).

    One of: "pending", "active"