Skip to main content

model.proto

path sdk/model/model.proto

package m10.sdk.model


Messages​

AccountInfo​

NameTypeDescription
account_idbytesUnique identifier for the account.
parent_account_idbytesIdentifier of the parent account, if any.
public_namestringPublic name of the account.
profile_image_urlstringURL of the account's profile image.
codestringAccount code (e.g., currency code).
decimal_placesuint32Number of decimal places for the account's value.
display_codestringUnique display code for the account (e.g., currency code). Equals `code` if not set.

AccountMetadata​

NameTypeDescription
ownerbytesThe owner of the AccountMetadata
profile_image_urlstringURL of the profile image associated with the account.
namestringName of the AccountMetadata.
public_namestringPublic name of the AccountMetadata.
idbytesUnique identifier (e.g. UUID) for the AccountMetadata.
isinstringInternational Securities Identification Number.
dtistringDigital Token Identifier.
issuer_bank_idstringIssuer bank id

AccountSet​

NameTypeDescription
ownerbytesThe owner of the AccountSet.
accountsrepeated bytesList of account references within the AccountSet.
idbytesUnique identifier (e.g. UUID) for the AccountSet.

Bank​

NameTypeDescription
idbytesUnique identifier for the bank.
ownerbytesOwner of the bank collection record.
short_namestringShort name of the bank.
display_namestringDisplay name of the bank.
accountsrepeated BankAccountRefList of BankAccountRef's.
statusBank.BankStatusOperational status of the bank.
country_codestringISO 3166-1 alpha-2 country code of the bank's jurisdiction.
endpointstringURL of the bank's integration service endpoint.
logo_urlstringURL of the bank's logo image.
descriptionstringHuman-readable description of the bank.
bic_swift_codestringBIC/SWIFT code identifying the bank in international transfers.

BankAccountRef​

NameTypeDescription
account_idbytesUnique identifier for the bank account.
account_typeBankAccountRef.BankAccountTypeBank account type.

Enums​

Bank.BankStatus​

Operational status of a bank, aligned with the FIS US Consortium Scheme Rulebook.

NameNumberDescription
ACTIVE0Bank is operational. Default value; existing records without the field read as ACTIVE.
PENDING1Bank is awaiting activation; onboarding not yet complete.
SUSPENDED2Bank has been suspended by the Operator. The bank may not initiate new / transactions but continues to receive and process incoming transactions.
TERMINATED3Bank membership has been terminated, whether voluntarily, involuntarily, / or automatically upon licence revocation.

BankAccountRef.BankAccountType​

Bank account type.

NameNumberDescription
CBDC0Central Bank Digital Currency.
DRM1Digital Regulated Money.