AccountService

AccountService provides all the methods for retrieving and summarizing account information.

GetAccount

GetAccount retrieves the account information for a single account.

GET /v2/account/{account_id}

GetAccountRequest

GetAccountRequest holds the get account request information.

Field	Type	Label	Description
account_id	string		account_id is the account unique identifier.

GetAccountResponse

GetAccountResponse holds the get account response information.

Field	Type	Label	Description
account	brankas.v2.api.Account		account is the account information.
refresh_date	google.protobuf.Timestamp		refresh_date is the timestamp when the balance data was updated.

GetAccounts

GetAccounts retrieves the list of all accounts registered to the brankas service.

GET /v2/account

GetAccountsResponse

Field	Type	Label	Description
accounts	brankas.v2.api.Account	repeated	accounts is a list of all organization accounts.

UpdateAccount

UpdateAccount changes the nick of an account.

POST /v2/account/{account_id}

UpdateAccountRequest

UpdateAccountRequest holds the update account request information

Field	Type	Label	Description
account_id	string		account_id is the account unique identifier.
nick	string		nick is the new nickname to apply to the account.

UpdateAccountResponse

UpdateAccountResponse holds the update account response information

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the success status of the update.

MetaService

MetaService provides metadata method for the Brankas API.

Metadata

Metadata returns the system metadata.

GET /v2/meta

MetaResponse

MetaResponse is the metadata response.

Field	Type	Label	Description
countries	Country	repeated	countries is the list of countries.
banks	Bank	repeated	banks is the list of banks.
currencies	Currency	repeated	currencies is the list of currencies.

UtilService

UtilService provides utility methods for the Brankas API.

CheckStatus

CheckStatus retrieves the server health status.

GET /v2/status

package mainimport ("io""net/http""os")func main() {resp, _ := http.Get("https://a.brank.as/v2/status")defer resp.Body.Close()io.Copy(os.Stdout, resp.Body)}

CheckStatusResponse

CheckStatusResponse contains information about the underlying system status.

{ "status": "OK" }

Field	Type	Label	Description
status	CheckStatusResponse.OkStatus		status is the status of the request.

Echo

Echo echoes the passed message request.

POST /v2/echo

package mainimport ("bytes""io""net/http""os")func main() {resp, _ := http.Post("https://a.brank.as/v2/echo", "json",bytes.NewBuffer([]byte(`{ "msg": "Hello, World!"}`)))defer resp.Body.Close()io.Copy(os.Stdout, resp.Body)}

EchoMessage

EchoMessage is an echo message.

Field	Type	Label	Description
msg	string		msg is the content to echo.

AuthService

AuthService defines the authorization service for Brankas systems.

ConfirmationCode

ConfirmationCode confirms the input code or email for registration. Status code signals success (Confirmed: 200)

POST /v2/confimcode

ConfirmationCodeRequest

ConfirmationCodeRequest contains the confirmation code reqest.

Field	Type	Label	Description
invite_code	string		invite_code is the alphanumeric invite code.
email	string		email is the confirmation email address.

POST /v2/login

LoginRequest

LoginRequest contains the login credentials.

Field	Type	Label	Description
credential	brankas.v2.api.Credential		credential is the login credential.

LoginResponse

LoginResponse contains the JWT token.

Field	Type	Label	Description
token	string		token is the authentication token.

RevokeToken

RevokeToken revokes the token’s authorized session. status code signals success (Revoked: 200, Bad Token: 401)

POST /v2/revoke

RevokeRequest

RevokeRequet contains the revoke JWT request details.

Field	Type	Label	Description
token	string		token is the JWT to be revoked.

ValidateToken

ValidateToken validates a given JWT token.

POST /v2/validate

ValidateRequest

ValidateRequest contains the JWT token to be validated.

Field	Type	Label	Description
token	string		token is the jwt token.

ValidateResponse

ValidateResponse contains the validated JWT details.

Field	Type	Label	Description
admin	bool		admin is a flag to identify administrative priveledges within the organization.
org_id	string		org_id is the identifier of the access validated organization.

BankCredentialService

BankCredentialService provides all the methods for creating, retrieving, and manipulating bank credentials.

CreateBankCredential

CreateBankCredential creates a new bank credential entry for the specified bank code.

POST /v2/bankcredential

CreateBankCredentialRequest

CreateBankCredentialRequest holds the create bank credential request information.

Field	Type	Description
bank_code	brankas.v2.api.BankCode	bank_code is the bank code (MANDIRI, BCA, etc).
credential	brankas.v2.api.Credential	credential is the encrypted credential.
title	string	title is optional title to associate with the bank credential.

CreateBankCredentialResponse

CreateBankCredentialResponse holds the create bank credential response information.

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the result of the reqest.
bankcredential_id	string		bankcredential_id is the created credential id.

DeleteBankCredential

DeleteBankCredential deletes a bank credential.

DELETE /v2/bankcredential/{bankcredential_id}

DeleteBankCredentialRequest

DeleteBankCredentialRequest holds the delete bank credential request information.

Field	Type	Label	Description
bankcredential_id	string		bankcredential_id is the credential id to delete.

DeleteBankCredentialResponse

DeleteBankCredentialResponse holds the delete bank credential response information.

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the success status of the request.

MatchService

MatchService provides the methods for initiating a request for payment matching, and for manually associating transactions.

CancelMatch

CancelMatch cancels the match and removes all transaction associations.

DELETE /v2/match/{match_id}

CancelMatchRequest

CancelMatchRequest holds the cancel match request information.

Field	Type	Label	Description
match_id	string		match_id is the created match id.

CancelMatchResponse

CancelMatchResponse holds the cancel match response information.

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the result status of the request.

CreateMatch

CreateMatch initiates a payment match.

POST /v2/match

CreateMatchRequest

CreateMatchRequest holds the create match request information.

Field	Type	Description
from	brankas.v2.api.AccountDesc	from is the from account information.
account_id	string	account_id is the account identifier for the account to expect the transaction.
amount	brankas.v2.api.Amount	amount is the payment amount.
memo	string	memo is the user supplied short transaction memo.
expiry	google.protobuf.Timestamp	expiry is the deadline for matching a transaction for payment.
note	string	note is an optional user-defined field.

CreateMatchResponse

CreateMatchResponse holde the create match response information.

Field	Type	Description
status	brankas.v2.api.SuccessStatus	status is the result status of the request.
match_id	string	match_id is the unique match identifier.
short_id	string	short_id is the short match id.

GetMatch

GetMatch retrieves the match data.

GET /v2/match/{match_id}

GetMatchRequest

GetMatchRequest holds the get match request information.

Field	Type	Label	Description
match_id	string		match_id is the unique match identifier.

GetMatchResponse

GetMatchResponse holds the get match response information.

Field	Type	Label	Description
match	brankas.v2.api.Match		match is the returned match information.

GetMatches

GetMatches retrieves the match data for a set of matches.

GET /v2/match

GetMatchesRequest

GetMatchesRequest holds the list of get matches request information.

Field	Type	Label	Description
ids	GetMatchRequest	repeated

GetMatchesResponse

GetMatchesResponse holds the list of get matches response information.

Field	Type	Label	Description
matches	brankas.v2.api.Match	repeated

UpdateMatch

UpdateMatch updates the match data.

POST /v2/match/{match_id}

UpdateMatchRequest

UpdateMatchRequest holds the update match request information.

Field	Type	Description
match_id	string	match_id is the unique match identifier.
amount	brankas.v2.api.Amount	amount is the payment amount.
expiry	google.protobuf.Timestamp	expiry is the deadline for matching a transaction for payment.
note	string	note is an optional user-defined field.

UpdateMatchResponse

UpdateMatchResponse holde the update match response information.

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the result status of the request.

OrgService

OrgService provides organization management.

GetOrg

GetOrg fetches the organization information.

GET /v2/org/{org_id}

GetOrgRequest

GetOrgRequest holds the get org request search parameters.

Field	Type	Label	Description
org_id	string		search_fields holds search parameters.

GetOrgResponse

GetOrgResponse holds the org information.

Field	Type	Label	Description
org	brankas.v2.api.OrgProfile		org is the organization information.

RegisterOrg

RegisterOrg registers a new organization.

POST /v2/org

RegisterOrgRequest

RegisterOrgRequest holds the register orgrequest information.

Field	Type	Label	Description
user_agent	string		user_agent is the client user agent.
org	brankas.v2.api.OrgProfile		org is the organization information.

RegisterOrgResponse

RegisterOrgResponse holds the register orgresponse information.

Field	Type	Description
status	OrgStatus	status is the organization status.
org_id	string	extra contains additional information if the registration failed.
token	string	token contains an authorized token that allows registration of the org owner via orguser service.

Update

Update updates organization data.

POST /v2/org/{org_id}

UpdateOrgRequest

UpdateOrgRequest holds the update organization information.

Field	Type	Label	Description
org_id	string		org_id is the organization unique identifier.
org	brankas.v2.api.OrgProfile		org is the organization information.

UpdateOrgResponse

UpdateOrgResponse holds the update organization information.

Field	Type	Label	Description
status	OrgStatus		status is the organization status.

OrgUserService

OrgUserService provides orgUser management.

GetOrgUsers

GetOrgUsers fetches all orgUsers matching the search parameters. Search is restricted to the authenticated organization.

GET /v2/orgUser

GetOrgUserRequest

GetOrgUserRequest holds the get orgUser request search parameters.

Field	Type	Label	Description
search_fields	brankas.v2.api.Profile		search_fields holds search parameters.

GetOrgUserResponse

GetOrgUserResponse holds the matching orgUser(s).

Field	Type	Label	Description
profiles	brankas.v2.api.Profile	repeated	profiles is the list of profiles.

RegisterOrgUser

RegisterOrgUser registers a new orgUser.

POST /v2/orgUser

RegisterOrgUserRequest

RegisterOrgUserRequest holds the register organization user request information.

Field	Type	Description
user_agent	string	user_agent is the client user agent.
credential	brankas.v2.api.Credential	credential is the initial credential to assign with the profile.
profile	brankas.v2.api.Profile	profile is the user’s initial profile information.

RegisterOrgUserResponse

RegisterOrgUserResponse holds the register orgUser response information.

Field	Type	Description
status	ProfileStatus	status is the profile status.
extra	string	extra contains additional information if the registration failed.
user_id	string	user_id is the user’s unique identifier.
token	string	token is authorized to modify the orguser with UpdateOrgUser.

UpdateOrgUser

UpdateOrgUser updates orgUser data.

POST /v2/orgUser/{user_id}

UpdateOrgUserRequest

UpdateOrgUserRequest holds the update orgUser request information.

Field	Type	Label	Description
user_id	string		orgUser_id is the user’s unique identifier.
profile	brankas.v2.api.Profile		profile is the updated profile information.

UpdateOrgUserResponse

UpdateOrgUserResponse holds the update organization user response information.

Field	Type	Label	Description
status	ProfileStatus		status is the profile status.

TFAService

TFAService provides the methods for sending two-factor authentication tokens.

SendTFA

SendTFA submits a two-factor authentication code.

POST /v2/tfa

SendTFARequest

SendTFARequest holds the two-factor authentication request.

Field	Type	Description
purpose	TFAPurpose	purpose defines what this TFA token should be used for.
purpose_id	string	id will be a bankcredential_id.
token	string	token is the actual TFA token string.

SendTFAResponse

SendTFAResponse holds the two-factor authentication response.

Field	Type	Description
status	brankas.v2.api.SuccessStatus	status is the success status of the request.
auth_status	SendTFAResponse.Status	auth_status is the authentication status.
status_msg	string	status_msg is the bank status message.

TransactionService

TransactionService provides the methods for initiating a transaction, and for manually progressing through each of the transaction steps.

AdvanceTransaction

AdvanceTransaction moves to the next stage of the transaction, and returns any relevant information such as captcha data to the client.

POST /v2/transaction/{transaction_id}/advance

AdvanceTransactionRequest

AdvanceTransactionRequest holds the advance transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.
data	brankas.v2.api.FormInfo		data is the chat state data needed to advance the transaction.

AdvanceTransactionResponse

AdvanceTransactionResponse holds the advance transaction response information.

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the success status of the request.
data	brankas.v2.api.FormInfo		data is the chat state data if there was an error.

CreateTransaction

CreateTransaction initiates a transaction.

POST /v2/transaction

CreateTransactionRequest

CreateTransactionRequest holds the create transaction request information.

Field	Type	Description
account_id	string	account_id is the from account identifier.
to	brankas.v2.api.AccountDesc	to is the to account information.
amount	brankas.v2.api.Amount	amount is the transaction amount.
memo	string	memo is the user supplied short transaction memo.

CreateTransactionResponse

CreateTransactionResponse holds the create transaction response information.

Field	Type	Description
status	brankas.v2.api.SuccessStatus	status is the result status of the request.
transaction_id	string	transaction_id is the created transaction id.
short_id	string	short_id is the short transaction id.
url	string	url is the URL for sharing the transaction with a user.

DeleteTransaction

DeleteTransaction cancels an initiated transaction.

DELETE /v2/transaction/{transaction_id}

DeleteTransactionRequest

DeleteTransactionRequest holds the delete transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.

DeleteTransactionResponse

DeleteTransactionResponse holds the delete transaction request information.

Field	Type	Label	Description
status	brankas.v2.api.SuccessStatus		status is the success status of the request.

GetTransaction

GetTransaction retrieves transaction information.

GET /v2/transaction/{transaction_id}

GetTransactionRequest

GetTransactionRequest holds the get transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.

GetTransactionResponse

GetTransactionResponse holds the get transaction response information.

Field	Type	Label	Description
transaction	brankas.v2.api.Transaction

GetTransactions

GetTransactions retrieves a set of transactions.

GET /v2/transaction

GetTransactionsRequest

GetTransactionsRequest holds the get transaction request information.

Field	Type	Label	Description
ids	GetTransactionRequest	repeated	ids is the list of transaction ids.
since	google.protobuf.Timestamp		since is the oldest transaction to fetch.
max_count	uint32		max_count is the maximum number of transactions to fetch.

GetTransactionsResponse

GetTransactionsResponse holds the get transaction response information.

Field	Type	Label	Description
transactions	brankas.v2.api.Transaction	repeated	transactions is the list of transactions.
credits_total	brankas.v2.api.Amount	repeated	credits_total is the sum total of all deposit transactions
debits_total	brankas.v2.api.Amount	repeated	debits_total is the sum total of all deposit transactions

PollTransaction

PollTransaction retrieves the state of an initiated transaction.

GET /v2/transaction/{transaction_id}/poll

PollTransactionRequest

PollTransactionRequest holds the poll transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.

PollTransactionResponse

PollResponse holds the poll chat response information.

Field	Type	Label	Description
status	PollTransactionResponse.Status		status is the current status of the transaction.
data	brankas.v2.api.FormInfo		data contains the current form data of the transaction.

Datatypes

Package Namespace brankas.v2.account

GetAccountRequest

GetAccountRequest holds the get account request information.

Field	Type	Label	Description
account_id	string		account_id is the account unique identifier.

GetAccountResponse

GetAccountResponse holds the get account response information.

Field	Type	Label	Description
account	Account		account is the account information.
refresh_date	Timestamp		refresh_date is the timestamp when the balance data was updated.

GetAccountsResponse

Field	Type	Label	Description
accounts	Account	repeated	accounts is a list of all organization accounts.

UpdateAccountRequest

UpdateAccountRequest holds the update account request information

Field	Type	Label	Description
account_id	string		account_id is the account unique identifier.
nick	string		nick is the new nickname to apply to the account.

UpdateAccountResponse

UpdateAccountResponse holds the update account response information

Field	Type	Label	Description
status	SuccessStatus		status is the success status of the update.

Package Namespace brankas.v2.api

Account

Account contains information for a single bank account.

Field	Type	Label	Description
account_id	string		account_id is a unique bank account identifier.
type	Type
owner_ids	string	repeated	owner_ids is the list of bank credential identifiers that own and have access to this account. The first in the list is the primary owner, and the list cannot be empty.
account_number	string		account_number is the account number.
nick	string		nick is an optional nickname for the account.
balance	Amount		balance is the most recent account balance.

AccountDesc

AccountDesc holds information pertaining to an account.

Field	Type	Description
type	Type	type is the account info type.
bank_code	BankCode	bank_code is a bank code. Only present when type is BANK.
identifier	string	identifier is a unique account id, profile id, or the bank account number and is interpreted based on the account info type.

Amount

Amount is a currency and number corresponding to an amount.

Field	Type	Label	Description
cur	string		cur is the currency.
num	string		num is the numeric value.

Bank

Bank is a banking institution record.

Field	Type	Description
bank_code	BankCode	bank_code is the bank institution identifier.
name	string	name is the bank name.
country_code	string	country_code is the bank location identifier.
enabled	bool	enabled is the system connection flag.
online	bool	online is the bank system’s status flag.

BankInfo

BankInfo contains information about a bank.

Field	Type	Description
bank_code	BankCode	bank_code is the bank code.
name	string	name is the bank name (mandiri, bca, …).
title	string	title is the display title for the bank.
country	string	country is the country code (ID, US, SG, …).
enabled	bool	enabled indicates whether or not the bank is enabled.

BankStatus

Field	Type	Description
online	bool	online is a status flag to show the bank server is online.
online_date	Timestamp	online_date is the time of last update to the online flag.
timeout	bool	timeout is a status flag to show the bank session has been terminated.
timeout_date	Timestamp	timeout_date is the time of last update to the timeout flag.
error_msg	string	error_msg holds any error messages from the bank.

CheckStatusResponse

CheckStatusResponse contains information about the underlying system status.

Field	Type	Label	Description
status	OkStatus		status is the status of the request.

CoordinateInfo

CoordinateInfo contains info pertaining to a GPS coordinate.

Field	Type	Label	Description
lat	double		lat is the latitude.
long	double		long is the longitude.

Country

Country is an country record.

Field	Type	Description
country_code	string	country_code is the 2-character identifier.
language	string	language is the primary language code.
name	string	name is the country name.

Credential

Credential contains confidential access credential information.

Field	Type	Description
type	Type	type is the type of the credential.
identifier	string	identifier is the unique identifier for the credential (ie, a phone number, email, token, etc).
secret	string	secret is the secret to exchange for validating the credential.

Currency

Currency is a curency record.

Field	Type	Description
currency_code	string	currency_code is the ISO 3 character currency code (ie, ‘USD’, ‘SGD’, etc).
symbol	string	symbol is the currency symbol (ie, ‘$’, ‘Rp.’).
separator	string	separator is the thousands separator (ie, ‘.’, ‘,’).
decimal	string	decimal is the decimal character (ie, ‘.’, ‘,’).
digits	int32	digits are the number of significant digits to display after the decimal.
show_digits	bool	show_digits dictates how to display
cformat	string	cformat is a C-compatible formatting string (ie, ‘$%d.%d’, ‘Rp. %d,%d’).
cformat_short	string	cformat_short is the C-compatible formatting string to display the short format (ie, ‘$%d’, ‘Rp. %d’).

EchoMessage

EchoMessage is an echo message.

Field	Type	Label	Description
msg	string		msg is the content to echo.

FieldInfo

FieldInfo contains information pertaining to a form field.

Field	Type	Label	Description
field_num	uint32		field_num is the field number (ie, ordinal position).
type	Type
name	string		name is the name of the field.
title	string		title is the displayable title of the field.
value	string		value is the value of the field (if the field needs to be prepopulated).
options	OptionsEntry	repeated	options are the options name value pairs for radio, check and select field types.
help_text	HelpTextEntry	repeated	help contains a key, value pair of help text to be interpreted by the UI as necessary.
error_text	ErrorTextEntry	repeated	error_text contains the key, value pair of error text to be interpretted by the UI as necessary.
extra	string		extra contains raw data to be interpreted by the field.
editable	bool		editable is whether or not the field can be changed by the user.

ErrorTextEntry

Field	Type	Label	Description
key	string
value	string

HelpTextEntry

Field	Type	Label	Description
key	string
value	string

OptionsEntry

Field	Type	Label	Description
key	string
value	string

Filter

Filter contains the filter information for a single field.

Field	Type	Label	Description
operation	string		comparison operation.
filter_term	string		filter_term is the input to the filter comparison.

FilterField

FilterField contains the filtering information for a single field.

Field	Type	Label	Description
name	string		name is the name of the data field being filtered.
filter	Filter	repeated	filter are the filtering operations to be applied to the field.

FilterSet

FilterSet contains a set of filters to be applied together.

Field	Type	Label	Description
fields	FilterField	repeated	fields contains the filtering for each filtered field.

FormInfo

FormInfo contains information pertaining to one step in a multi step form.

Field	Type	Label	Description
type	Type		type is the form type.
step	uint32		step is the 0..N state step number.
name	string		name is the current step name.
title	string		title contains the displayable title of the form.
help_text	HelpTextEntry	repeated	help contains a key, value pair of help text to be interpreted by the UI as necessary.
error_text	ErrorTextEntry	repeated	error_text contains the key, value pair of error text to be interpretted by the UI as necessary.
button_title	string		button_title is the text that should be displayed as the text for the form’s submission button.
fields	FieldInfo	repeated	fields are the fields that need to be collected for the current state.

ErrorTextEntry

Field	Type	Label	Description
key	string
value	string

HelpTextEntry

Field	Type	Label	Description
key	string
value	string

Match

Field	Type	Label	Description
match_id	string		match_id is the unique match identifier.
short_id	string		short_id is the short match id.
account_id	string		account_id is the account where the deposit is expected.
status	MatchStatus		status is the match status.
date	Timestamp		date is the creation timestamp.
expiry	Timestamp		expiry is the match expiration timestamp.
from_account	AccountDesc		from_account is the debit account information.
memo_code	string		memo_code is the match identifier.
total	Amount		total is the total amount to be matched.
note	string		note is an optional user-defined field.
settled	Timestamp		settled is the timestamp when the settling transaction was matched.
final_match	TransactionMatch		final_match is the final match with a transaction.
possible_matches	PossibleMatchesEntry	repeated	id to TransactionMatch.

PossibleMatchesEntry

Field	Type	Label	Description
key	string
value	TransactionMatch

MetaResponse

MetaResponse is the metadata response.

Field	Type	Label	Description
countries	Country	repeated	countries is the list of countries.
banks	Bank	repeated	banks is the list of banks.
currencies	Currency	repeated	currencies is the list of currencies.

OrgProfile

OrgProfile is the organization profile information.

Field	Type	Description
org_id	string	org_id is the organization unique identifier.
name	string	name is the organization name.
address	string	address is the organization street address.
email	string	email is the organization contact email.
phone	string	phone is the organization phone number.

Profile

Profile is the user’s profile information.

Field	Type	Description
profile_id	string	profile_id is the user’s profile identifier.
name	string	name is the user’s name.
lang	string	lang is the user’s language code (en, id, …).
country	string	country is the user’s country code (ID, US, SG, …).

ResourceInfo

ResourceInfo contains general web resource information.

Field	Type	Description
type	Type
token_type	string	token_type is the token type for use with oauth2.
token	string	token is the authorization token.
base_url	string	base_url is the base url for the resource.
auth_url	string	auth_url is the oauth2 authorization url.
token_url	string	token_url is the oauth2 token url.

Transaction

Transaction contains information for a specific transaction.

Field	Type	Description
transaction_id	string	transaction_id is the transaction id.
match_id	string	match_id is the related match identifier (if any).
from_account	string	from_account is the account number of the debited account (if any).
account_id	string	account_id is the account identifier of the credited account.
descriptor	string	descriptor is the bank statement descriptor.
date	Timestamp	date is the transaction date.
amount	Amount	amount is the transaction amount.
type	Type	type is the type of bank transaction (DEBIT, CREDIT, TRANSFER)
pending	bool	pending is a flag for transactions marked by the bank as pending.

TransactionMatch

Field	Type	Label	Description
transaction_id	string		transaction_id is the id of the transaction record.
match_strength	float		match_strength is the overall match strength estimate. Its range is [0, 1].
fields	FieldsEntry	repeated	fields is a map of { field_name : stregth } for each entry in the matching breakdown.

FieldsEntry

Field	Type	Label	Description
key	string
value	float

Type

Type is the account type enum.

Name	Description
UNKNOWN
CHECKING
SAVINGS

Type

Type is the account info type enum.

Name	Description
UNKNOWN
ACCOUNT
PROFILE
BANK
MSISDN

BankCode

BankCode is the bank code enum type.

Name	Description
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI

OkStatus

OkStatus is a the generic OK status enum.

Name	Description
UNKNOWN
ERROR
OK

Type

Type is the credential type enum.

Name	Description
UNKNOWN
MSISDN
EMAIL
TOKEN

Type

Type is the field type enum.

Name	Description
EMPTY
TEXT
RADIO
CHECK
SELECT
CAPTCHA
AMOUNT

Type

Type is the form type enum type.

Name	Description
UNKNOWN
ERROR
INPUT
COMPLETE

MatchStatus

MatchStatus is the match status enum type.

Name	Description
OPEN
READY
SETTLED
CANCELLED
EXPIRED

Type

Type is the resource type enum.

Name	Description
NONE
BRANKAS_V2
FIRESTORE_V1

SuccessStatus

SuccessStatus is a the success status enum type.

Name	Description
UNKNOWN
ERROR
SUCCESS

Type

Name	Description
UNKNOWN
DEBIT
CREDIT
TRANSFER

Package Namespace brankas.v2.auth

ConfirmationCodeRequest

ConfirmationCodeRequest contains the confirmation code reqest.

Field	Type	Label	Description
invite_code	string		invite_code is the alphanumeric invite code.
email	string		email is the confirmation email address.

LoginRequest

LoginRequest contains the login credentials.

Field	Type	Label	Description
credential	Credential		credential is the login credential.

LoginResponse

LoginResponse contains the JWT token.

Field	Type	Label	Description
token	string		token is the authentication token.

RevokeRequest

RevokeRequet contains the revoke JWT request details.

Field	Type	Label	Description
token	string		token is the JWT to be revoked.

ValidateRequest

ValidateRequest contains the JWT token to be validated.

Field	Type	Label	Description
token	string		token is the jwt token.

ValidateResponse

ValidateResponse contains the validated JWT details.

Field	Type	Label	Description
admin	bool		admin is a flag to identify administrative priveledges within the organization.
org_id	string		org_id is the identifier of the access validated organization.

Package Namespace brankas.v2.bank

CreateBankCredentialRequest

CreateBankCredentialRequest holds the create bank credential request information.

Field	Type	Description
bank_code	BankCode	bank_code is the bank code (MANDIRI, BCA, etc).
credential	Credential	credential is the encrypted credential.
title	string	title is optional title to associate with the bank credential.

CreateBankCredentialResponse

CreateBankCredentialResponse holds the create bank credential response information.

Field	Type	Label	Description
status	SuccessStatus		status is the result of the reqest.
bankcredential_id	string		bankcredential_id is the created credential id.

DeleteBankCredentialRequest

DeleteBankCredentialRequest holds the delete bank credential request information.

Field	Type	Label	Description
bankcredential_id	string		bankcredential_id is the credential id to delete.

DeleteBankCredentialResponse

DeleteBankCredentialResponse holds the delete bank credential response information.

Field	Type	Label	Description
status	SuccessStatus		status is the success status of the request.

Package Namespace brankas.v2.match

CancelMatchRequest

CancelMatchRequest holds the cancel match request information.

Field	Type	Label	Description
match_id	string		match_id is the created match id.

CancelMatchResponse

CancelMatchResponse holds the cancel match response information.

Field	Type	Label	Description
status	SuccessStatus		status is the result status of the request.

CreateMatchRequest

CreateMatchRequest holds the create match request information.

Field	Type	Description
from	AccountDesc	from is the from account information.
account_id	string	account_id is the account identifier for the account to expect the transaction.
amount	Amount	amount is the payment amount.
memo	string	memo is the user supplied short transaction memo.
expiry	Timestamp	expiry is the deadline for matching a transaction for payment.
note	string	note is an optional user-defined field.

CreateMatchResponse

CreateMatchResponse holde the create match response information.

Field	Type	Description
status	SuccessStatus	status is the result status of the request.
match_id	string	match_id is the unique match identifier.
short_id	string	short_id is the short match id.

GetMatchRequest

GetMatchRequest holds the get match request information.

Field	Type	Label	Description
match_id	string		match_id is the unique match identifier.

GetMatchResponse

GetMatchResponse holds the get match response information.

Field	Type	Label	Description
match	Match		match is the returned match information.

GetMatchesRequest

GetMatchesRequest holds the list of get matches request information.

Field	Type	Label	Description
ids	GetMatchRequest	repeated

GetMatchesResponse

GetMatchesResponse holds the list of get matches response information.

Field	Type	Label	Description
matches	Match	repeated

UpdateMatchRequest

UpdateMatchRequest holds the update match request information.

Field	Type	Description
match_id	string	match_id is the unique match identifier.
amount	Amount	amount is the payment amount.
expiry	Timestamp	expiry is the deadline for matching a transaction for payment.
note	string	note is an optional user-defined field.

UpdateMatchResponse

UpdateMatchResponse holde the update match response information.

Field	Type	Label	Description
status	SuccessStatus		status is the result status of the request.

Package Namespace brankas.v2.org

GetOrgRequest

GetOrgRequest holds the get org request search parameters.

Field	Type	Label	Description
org_id	string		search_fields holds search parameters.

GetOrgResponse

GetOrgResponse holds the org information.

Field	Type	Label	Description
org	OrgProfile		org is the organization information.

GetOrgUserRequest

GetOrgUserRequest holds the get orgUser request search parameters.

Field	Type	Label	Description
search_fields	Profile		search_fields holds search parameters.

GetOrgUserResponse

GetOrgUserResponse holds the matching orgUser(s).

Field	Type	Label	Description
profiles	Profile	repeated	profiles is the list of profiles.

RegisterOrgRequest

RegisterOrgRequest holds the register orgrequest information.

Field	Type	Label	Description
user_agent	string		user_agent is the client user agent.
org	OrgProfile		org is the organization information.

RegisterOrgResponse

RegisterOrgResponse holds the register orgresponse information.

Field	Type	Description
status	OrgStatus	status is the organization status.
org_id	string	extra contains additional information if the registration failed.
token	string	token contains an authorized token that allows registration of the org owner via orguser service.

RegisterOrgUserRequest

RegisterOrgUserRequest holds the register organization user request information.

Field	Type	Description
user_agent	string	user_agent is the client user agent.
credential	Credential	credential is the initial credential to assign with the profile.
profile	Profile	profile is the user’s initial profile information.

RegisterOrgUserResponse

RegisterOrgUserResponse holds the register orgUser response information.

Field	Type	Description
status	ProfileStatus	status is the profile status.
extra	string	extra contains additional information if the registration failed.
user_id	string	user_id is the user’s unique identifier.
token	string	token is authorized to modify the orguser with UpdateOrgUser.

UpdateOrgRequest

UpdateOrgRequest holds the update organization information.

Field	Type	Label	Description
org_id	string		org_id is the organization unique identifier.
org	OrgProfile		org is the organization information.

UpdateOrgResponse

UpdateOrgResponse holds the update organization information.

Field	Type	Label	Description
status	OrgStatus		status is the organization status.

UpdateOrgUserRequest

UpdateOrgUserRequest holds the update orgUser request information.

Field	Type	Label	Description
user_id	string		orgUser_id is the user’s unique identifier.
profile	Profile		profile is the updated profile information.

UpdateOrgUserResponse

UpdateOrgUserResponse holds the update organization user response information.

Field	Type	Label	Description
status	ProfileStatus		status is the profile status.

OrgStatus

OrgStatus is the organization status enum.

Name	Description
REGISTERED
ENABLED
SUSPENDED
DISABLED

ProfileStatus

ProfileStatus is the profile status enum.

Name	Description
UNKNOWN
FAILURE
SUCCESS
INTERNAL_ERROR
UPGRADE_REQUIRED
SUPPORTED
CREDENTIAL_MISSING
CREDENTIAL_INVALID
CREDENTIAL_DISABLED
USE
PROFILE_MISSING
PROFILE_INVALID
NAME
LANG
COUNTRY
MSISDN
PROFILE_DISABLED

Package Namespace brankas.v2.tfa

SendTFARequest

SendTFARequest holds the two-factor authentication request.

Field	Type	Description
purpose	TFAPurpose	purpose defines what this TFA token should be used for.
purpose_id	string	id will be a bankcredential_id.
token	string	token is the actual TFA token string.

SendTFAResponse

SendTFAResponse holds the two-factor authentication response.

Field	Type	Description
status	SuccessStatus	status is the success status of the request.
auth_status	Status	auth_status is the authentication status.
status_msg	string	status_msg is the bank status message.

Status

Name	Description
UNKNOWN
INCOMPLETE
COMPLETE

TFAPurpose

Name	Description
UnknownPurpose
BankCredentialLogin

Package Namespace brankas.v2.transaction

AdvanceTransactionRequest

AdvanceTransactionRequest holds the advance transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.
data	FormInfo		data is the chat state data needed to advance the transaction.

AdvanceTransactionResponse

AdvanceTransactionResponse holds the advance transaction response information.

Field	Type	Label	Description
status	SuccessStatus		status is the success status of the request.
data	FormInfo		data is the chat state data if there was an error.

CreateTransactionRequest

CreateTransactionRequest holds the create transaction request information.

Field	Type	Description
account_id	string	account_id is the from account identifier.
to	AccountDesc	to is the to account information.
amount	Amount	amount is the transaction amount.
memo	string	memo is the user supplied short transaction memo.

CreateTransactionResponse

CreateTransactionResponse holds the create transaction response information.

Field	Type	Description
status	SuccessStatus	status is the result status of the request.
transaction_id	string	transaction_id is the created transaction id.
short_id	string	short_id is the short transaction id.
url	string	url is the URL for sharing the transaction with a user.

DeleteTransactionRequest

DeleteTransactionRequest holds the delete transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.

DeleteTransactionResponse

DeleteTransactionResponse holds the delete transaction request information.

Field	Type	Label	Description
status	SuccessStatus		status is the success status of the request.

GetTransactionRequest

GetTransactionRequest holds the get transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.

GetTransactionResponse

GetTransactionResponse holds the get transaction response information.

Field	Type	Label	Description
transaction	Transaction

GetTransactionsRequest

GetTransactionsRequest holds the get transaction request information.

Field	Type	Label	Description
ids	GetTransactionRequest	repeated	ids is the list of transaction ids.
since	Timestamp		since is the oldest transaction to fetch.
max_count	uint32		max_count is the maximum number of transactions to fetch.

GetTransactionsResponse

GetTransactionsResponse holds the get transaction response information.

Field	Type	Label	Description
transactions	Transaction	repeated	transactions is the list of transactions.
credits_total	Amount	repeated	credits_total is the sum total of all deposit transactions
debits_total	Amount	repeated	debits_total is the sum total of all deposit transactions

PollTransactionRequest

PollTransactionRequest holds the poll transaction request information.

Field	Type	Label	Description
transaction_id	string		transaction_id is the transaction id.

PollTransactionResponse

PollResponse holds the poll chat response information.

Field	Type	Label	Description
status	Status		status is the current status of the transaction.
data	FormInfo		data contains the current form data of the transaction.

Status

Status is the poll chat status enum type.

Name	Description
NONE
WAITING
READY
ERROR