← Back to schema index

BankResource

SPEI participant bank in JSON:API shape. `id` and `attributes.code` are always equal (`id` is kept as the stable resource identifier even though `code` duplicates it).

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringAPI resource type (`bank` by default).
id*string5-digit code of the banking institution.
attributes*objectAttributes of the banking institution.
code*stringCode of the banking institution (5 digits). Same value as `id`.
name*stringOfficial name of the banking institution.
aliasesarrayAlternative names (brand/abbreviations) of the banking institution.

Used in operations

  • GET /v1/public/banks

Referenced by schemas