Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Bank provides operations for interacting with bank accounts. All operations operate for the authenticated user (identified via an "authorization" request header, where the type is "token" and the credential is the customer's ID).

• rpc OpenAccount (OpenAccountRequest, Account)

  bank.proto:15

  OpenAccount creates an account with the type and given initial deposit as its balance.

  message OpenAccountRequest

  bank.proto:36

  • int32 initial_deposit_cents = 1

  • Account.Type type = 2

• rpc CloseAccount (CloseAccountRequest, google.protobuf.Empty)

  bank.proto:18

  CloseAccount closes the indicated account. An account can only be closed if its balance is zero.

  message CloseAccountRequest

  bank.proto:41

  • uint64 account_number = 1

• rpc GetAccounts (google.protobuf.Empty, GetAccountsResponse)

  bank.proto:20

  GetAccounts lists all accounts for the current customer.

  message GetAccountsResponse

  bank.proto:45

  • repeated Account accounts = 1

• rpc GetTransactions (GetTransactionsRequest, stream Transaction)

  bank.proto:25

  GetTransactions streams all transactions that match the given criteria. If the given start date is not specified, transactions since beginning of time are included. Similarly, if the given end date is not specified, transactions all the way to the presnet are included.

  message GetTransactionsRequest

  bank.proto:64

  • uint64 account_number = 1

  • optional google.protobuf.Timestamp start = 2

  • optional google.protobuf.Timestamp end = 3

  message Transaction

  bank.proto:70

  • uint64 account_number = 1

  • uint64 seq_number = 2

  • optional google.protobuf.Timestamp date = 3

  • int32 amount_cents = 4

  • string desc = 5

• rpc Deposit (DepositRequest, BalanceResponse)

  bank.proto:27

  Deposit increases the balance of an account by depositing funds into it.

  message DepositRequest

  bank.proto:78

  • uint64 account_number = 1

  • int32 amount_cents = 2

  • DepositRequest.Source source = 3

  • string desc = 4

• rpc Withdraw (WithdrawRequest, BalanceResponse)

  bank.proto:29

  Withdraw decreases the balance of an account by withdrawing funds from it.

  message WithdrawRequest

  bank.proto:97

  • uint64 account_number = 1

  • int32 amount_cents = 2

  • string desc = 3

• rpc Transfer (TransferRequest, TransferResponse)

  bank.proto:33

  Transfer moves money from one account to another. The source and destination accounts can be with this bank (e.g. "local" account numbers) or can be external accounts, identified by their ACH routing and account numbers.

  message TransferRequest

  bank.proto:103

  • oneof source

    • uint64 source_account_number = 1

    • TransferRequest.ExternalAccount external_source = 2

  • oneof dest

    • uint64 dest_account_number = 3

    • TransferRequest.ExternalAccount external_dest = 4

  • int32 amount_cents = 5

  • string desc = 6

  message TransferResponse

  bank.proto:120

  • uint64 src_account_number = 1

  • int32 src_balance_cents = 2

  • uint64 dest_account_number = 3

  • int32 dest_balance_cents = 4

Support provides an interactive chat service, for customers to interact with the bank's support agents. A single stream, for either of the two methods, is a stateful connection to a single "chat session". Streams are initially disconnected (not part of any session). A stream must be disconnected from a session (via customer hang up or via agent leaving a session) before it can be connected to a new one.

• rpc ChatCustomer (stream ChatCustomerRequest, stream ChatCustomerResponse)

  support.proto:17

  ChatCustomer is used by a customer-facing app to send the customer's messages to a chat session. The customer is how initiates and terminates (via "hangup") a chat session. Only customers may invoke this method (e.g. requests must include customer auth credentials).

  message ChatCustomerRequest

  support.proto:29

  • oneof req

    • InitiateChat init = 1

      init is used when a chat stream is not part of a chat session. This is a stream's initial state, as well as the state after a "hang_up" request is sent. This creates a new state session or resumes an existing one.

    • string msg = 2

      msg is used to send the customer's messages to support agents.

    • Void hang_up = 3

      hang_up is used to terminate a chat session. If a stream is broken, but the session was not terminated, the client may initiate a new stream and use init to resume that session. Sessions are not terminated unless done so explicitly via sending this kind of request on the stream.

  message ChatCustomerResponse

  support.proto:57

  • oneof resp

    • Session session = 1

      session is sent from the server when the stream is connected to a chat session. This happens after an init request is sent and the stream is connected to either a new or resumed session.

    • AgentMessage msg = 2

      msg is sent from the server to convey agents' messages to the customer.

• rpc ChatAgent (stream ChatAgentRequest, stream ChatAgentResponse)

  support.proto:22

  ChatAgent is used by an agent-facing app to allow an agent to reply to a customer's messages in a chat session. The agent may accept a chat session, which defaults to the session awaiting an agent for the longest period of time (FIFO queue).

  message ChatAgentRequest

  support.proto:69

  • oneof req

    • AcceptChat accept = 1

      accept is used when an agent wants to join a customer chat session. It can be used to connect to a specific session (by ID), or to just accept the session for which the customer has been waiting the longest (e.g. poll a FIFO queue of sessions awaiting a support agent). It is possible for multiple agents to be connected to the same chat session.

    • string msg = 2

      msg is used to send a message to the customer. It will also be delivered to any other connected support agents.

    • Void leave_session = 3

      leave_session allows an agent to exit a chat session. They can always re-enter later by sending an accept message for that session ID.

  message ChatAgentResponse

  support.proto:100

  • oneof resp

    • Session accepted_session = 1

      accepted_session provides the detail of a chat session. The server sends this message after the agent has accepted a chat session.

    • ChatEntry msg = 2

      msg is sent by the server when the customer, or another support agent, sends a message in stream's current session.

    • Void session_ended = 3

      session_ended notifies the support agent that their currently connected chat session has been terminated by the customer.

• rpc GetFiles (TestRequest, TestResponse)

  example.proto:19

  message TestRequest

  example.proto:8

  • repeated string file_names = 1

  • repeated Extension extensions = 2

  message TestResponse

  example.proto:13

  • map<string, google.protobuf.FileDescriptorProto> file_protos = 1

  • optional google.protobuf.Timestamp last_update_date = 2

• rpc Ping (google.protobuf.Empty, google.protobuf.Empty)

  example.proto:20

Used in: ChatAgentRequest

• string session_id = 1

Used as response type in: Bank.OpenAccount

Used as field type in: GetAccountsResponse

• uint64 account_number = 1

• Account.Type type = 2

• int32 balance_cents = 3

Used in: Account, OpenAccountRequest

• UNKNOWN = 0

• CHECKING = 1

• SAVING = 2

• MONEY_MARKET = 3

• LINE_OF_CREDIT = 4

• LOAN = 5

• EQUITIES = 6

Used in: ChatCustomerResponse, ChatEntry

• string agent_name = 1

• string msg = 2

Used as response type in: Bank.Deposit, Bank.Withdraw

• uint64 account_number = 1

• int32 balance_cents = 2

Used in: ChatAgentResponse, Session

• optional google.protobuf.Timestamp date = 1

• oneof entry

  • string customer_msg = 2

  • AgentMessage agent_msg = 3

Used in: DepositRequest

• UNKNOWN = 0

• CASH = 1

• CHECK = 2

• ACH = 3

• WIRE = 4

Used in: TestRequest

• uint64 id = 1

• optional google.protobuf.Any data = 2

Used in: ChatCustomerRequest

• string resume_session_id = 1

Used in: ChatAgentResponse, ChatCustomerResponse

• string session_id = 1

• string customer_name = 2

• repeated ChatEntry history = 3

Used in: TransferRequest

• uint64 ach_routing_number = 1

• uint64 ach_account_number = 2

Used in: ChatAgentRequest, ChatAgentResponse, ChatCustomerRequest

• VOID = 0