NAV

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.

FieldTypeLabelDescription
account_idstringaccount_id is the account unique identifier.

GetAccountResponse

GetAccountResponse holds the get account response information.

FieldTypeLabelDescription
accountbrankas.v2.api.Accountaccount is the account information.
refresh_dategoogle.protobuf.Timestamprefresh_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

FieldTypeLabelDescription
accountsbrankas.v2.api.Accountrepeatedaccounts 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

FieldTypeLabelDescription
account_idstringaccount_id is the account unique identifier.
nickstringnick is the new nickname to apply to the account.

UpdateAccountResponse

UpdateAccountResponse holds the update account response information

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus 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.

FieldTypeLabelDescription
countriesCountryrepeatedcountries is the list of countries.
banksBankrepeatedbanks is the list of banks.
currenciesCurrencyrepeatedcurrencies 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" }
FieldTypeLabelDescription
statusCheckStatusResponse.OkStatusstatus 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.

FieldTypeLabelDescription
msgstringmsg is the content to echo.

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.

FieldTypeLabelDescription
bank_codebrankas.v2.api.BankCodebank_code is the bank code (MANDIRI, BCA, etc).
credentialbrankas.v2.api.Credentialcredential is the encrypted credential.
titlestringtitle is optional title to associate with the bank credential.

CreateBankCredentialResponse

CreateBankCredentialResponse holds the create bank credential response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the result of the reqest.
bankcredential_idstringbankcredential_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.

FieldTypeLabelDescription
bankcredential_idstringbankcredential_id is the credential id to delete.

DeleteBankCredentialResponse

DeleteBankCredentialResponse holds the delete bank credential response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus 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.

FieldTypeLabelDescription
match_idstringmatch_id is the created match id.

CancelMatchResponse

CancelMatchResponse holds the cancel match response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the result status of the request.

CreateMatch

CreateMatch initiates a payment match.

POST /v2/match

CreateMatchRequest

CreateMatchRequest holds the create match request information.

FieldTypeLabelDescription
frombrankas.v2.api.AccountDescfrom is the from account information.
account_idstringaccount_id is the account identifier for the account to expect the transaction.
amountbrankas.v2.api.Amountamount is the payment amount.
memostringmemo is the user supplied short transaction memo.
expirygoogle.protobuf.Timestampexpiry is the deadline for matching a transaction for payment.
notestringnote is an optional user-defined field.

CreateMatchResponse

CreateMatchResponse holde the create match response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the result status of the request.
match_idstringmatch_id is the unique match identifier.
short_idstringshort_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.

FieldTypeLabelDescription
match_idstringmatch_id is the unique match identifier.

GetMatchResponse

GetMatchResponse holds the get match response information.

FieldTypeLabelDescription
matchbrankas.v2.api.Matchmatch 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.

FieldTypeLabelDescription
idsGetMatchRequestrepeated

GetMatchesResponse

GetMatchesResponse holds the list of get matches response information.

FieldTypeLabelDescription
matchesbrankas.v2.api.Matchrepeated

UpdateMatch

UpdateMatch updates the match data.

POST /v2/match/{match_id}

UpdateMatchRequest

UpdateMatchRequest holds the update match request information.

FieldTypeLabelDescription
match_idstringmatch_id is the unique match identifier.
amountbrankas.v2.api.Amountamount is the payment amount.
expirygoogle.protobuf.Timestampexpiry is the deadline for matching a transaction for payment.
notestringnote is an optional user-defined field.

UpdateMatchResponse

UpdateMatchResponse holde the update match response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the result status of the request.

ProfileService

ProfileService provides profile management.

Login

Login creates a new session and returns a valid OAuth2 token.

POST /v2/profile/login

LoginRequest

LoginRequest holds the login request information.

FieldTypeLabelDescription
user_agentstringuser_agent is the client user agent.
credentialbrankas.v2.api.Credentialcredential is the credential to to use to complete the login.

LoginResponse

LoginResponse holds the login response information.

FieldTypeLabelDescription
statusClientStatusstatus is the client status.
extrastringextra contains additional information if the login failed.
resourcesLoginResponse.ResourcesEntryrepeatedresources are the avaliable resources.

map keys are the same as the ResourceInfo.Type.

Register

Register registers a new profile.

POST /v2/profile/register

RegisterRequest

RegisterRequest holds the register request information.

FieldTypeLabelDescription
user_agentstringuser_agent is the client user agent.
credentialbrankas.v2.api.Credentialcredential is the initial credential to assign with the profile.
profilebrankas.v2.api.Profileprofile is the user’s initial profile information.

RegisterResponse

RegisterResponse holds the register response information.

FieldTypeLabelDescription
statusClientStatusstatus is the client status.
extrastringextra contains additional information if the registration failed.
tokenstringtoken is the token to use with the verify credential request.

Update

Update updates profile data.

POST /v2/profile/update

UpdateRequest

UpdateRequest holds the update request information.

FieldTypeLabelDescription
profile_idstringprofile_id is the user’s profile identifier.
profilebrankas.v2.api.Profileprofile is the updated profile information.

UpdateResponse

UpdateResponse holds the update response information.

FieldTypeLabelDescription
statusClientStatusstatus is the client 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.

FieldTypeLabelDescription
purposeTFAPurposepurpose defines what this TFA token should be used for.
purpose_idstringid will be a bankcredential_id.
tokenstringtoken is the actual TFA token string.

SendTFAResponse

SendTFAResponse holds the two-factor authentication response.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the success status of the request.
auth_statusSendTFAResponse.Statusauth_status is the authentication status.
status_msgstringstatus_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.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.
databrankas.v2.api.FormInfodata is the chat state data needed to advance the transaction.

AdvanceTransactionResponse

AdvanceTransactionResponse holds the advance transaction response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the success status of the request.
databrankas.v2.api.FormInfodata 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.

FieldTypeLabelDescription
account_idstringaccount_id is the from account identifier.
tobrankas.v2.api.AccountDescto is the to account information.
amountbrankas.v2.api.Amountamount is the transaction amount.
memostringmemo is the user supplied short transaction memo.

CreateTransactionResponse

CreateTransactionResponse holds the create transaction response information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus is the result status of the request.
transaction_idstringtransaction_id is the created transaction id.
short_idstringshort_id is the short transaction id.
urlstringurl 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.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.

DeleteTransactionResponse

DeleteTransactionResponse holds the delete transaction request information.

FieldTypeLabelDescription
statusbrankas.v2.api.SuccessStatusstatus 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.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.

GetTransactionResponse

GetTransactionResponse holds the get transaction response information.

FieldTypeLabelDescription
transactionbrankas.v2.api.Transaction

GetTransactions

GetTransactions retrieves a set of transactions.

GET /v2/transaction

GetTransactionsRequest

GetTransactionsRequest holds the get transaction request information.

FieldTypeLabelDescription
idsGetTransactionRequestrepeatedids is the list of transaction ids.
sincegoogle.protobuf.Timestampsince is the oldest transaction to fetch.
max_countuint32max_count is the maximum number of transactions to fetch.

GetTransactionsResponse

GetTransactionsResponse holds the get transaction response information.

FieldTypeLabelDescription
transactionsbrankas.v2.api.Transactionrepeatedtransactions is the list of transactions.
credits_totalbrankas.v2.api.Amountrepeatedcredits_total is the sum total of all deposit transactions
debits_totalbrankas.v2.api.Amountrepeateddebits_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.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.

PollTransactionResponse

PollResponse holds the poll chat response information.

FieldTypeLabelDescription
statusPollTransactionResponse.Statusstatus is the current status of the transaction.
databrankas.v2.api.FormInfodata contains the current form data of the transaction.

Datatypes

Package Namespace brankas.v2.account

GetAccountRequest

GetAccountRequest holds the get account request information.

FieldTypeLabelDescription
account_idstringaccount_id is the account unique identifier.

GetAccountResponse

GetAccountResponse holds the get account response information.

FieldTypeLabelDescription
accountAccountaccount is the account information.
refresh_dateTimestamprefresh_date is the timestamp when the balance data was updated.

GetAccountsResponse

FieldTypeLabelDescription
accountsAccountrepeatedaccounts is a list of all organization accounts.

UpdateAccountRequest

UpdateAccountRequest holds the update account request information

FieldTypeLabelDescription
account_idstringaccount_id is the account unique identifier.
nickstringnick is the new nickname to apply to the account.

UpdateAccountResponse

UpdateAccountResponse holds the update account response information

FieldTypeLabelDescription
statusSuccessStatusstatus is the success status of the update.

Package Namespace brankas.v2.api

Account

Account contains information for a single bank account.

FieldTypeLabelDescription
account_idstringaccount_id is a unique bank account identifier.
typeType
owner_idsstringrepeatedowner_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_numberstringaccount_number is the account number.
nickstringnick is an optional nickname for the account.
balanceAmountbalance is the most recent account balance.

AccountDesc

AccountDesc holds information pertaining to an account.

FieldTypeLabelDescription
typeTypetype is the account info type.
bank_codeBankCodebank_code is a bank code. Only present when type is BANK.
identifierstringidentifier 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.

FieldTypeLabelDescription
curstringcur is the currency.
numstringnum is the numeric value.

Bank

Bank is a banking institution record.

FieldTypeLabelDescription
bank_codeBankCodebank_code is the bank institution identifier.
namestringname is the bank name.
country_codestringcountry_code is the bank location identifier.
enabledboolenabled is the system connection flag.
onlineboolonline is the bank system’s status flag.

BankInfo

BankInfo contains information about a bank.

FieldTypeLabelDescription
bank_codeBankCodebank_code is the bank code.
namestringname is the bank name (mandiri, bca, …).
titlestringtitle is the display title for the bank.
countrystringcountry is the country code (ID, US, SG, …).
enabledboolenabled indicates whether or not the bank is enabled.

BankStatus

FieldTypeLabelDescription
onlineboolonline is a status flag to show the bank server is online.
online_dateTimestamponline_date is the time of last update to the online flag.
timeoutbooltimeout is a status flag to show the bank session has been terminated.
timeout_dateTimestamptimeout_date is the time of last update to the timeout flag.
error_msgstringerror_msg holds any error messages from the bank.

CheckStatusResponse

CheckStatusResponse contains information about the underlying system status.

FieldTypeLabelDescription
statusOkStatusstatus is the status of the request.

CoordinateInfo

CoordinateInfo contains info pertaining to a GPS coordinate.

FieldTypeLabelDescription
latdoublelat is the latitude.
longdoublelong is the longitude.

Country

Country is an country record.

FieldTypeLabelDescription
country_codestringcountry_code is the 2-character identifier.
languagestringlanguage is the primary language code.
namestringname is the country name.

Credential

Credential contains confidential access credential information.

FieldTypeLabelDescription
typeTypetype is the type of the credential.
identifierstringidentifier is the unique identifier for the credential (ie, a phone number, email, token, etc).
secretstringsecret is the secret to exchange for validating the credential.

Currency

Currency is a curency record.

FieldTypeLabelDescription
currency_codestringcurrency_code is the ISO 3 character currency code (ie, ‘USD’, ‘SGD’, etc).
symbolstringsymbol is the currency symbol (ie, ‘$’, ‘Rp.’).
separatorstringseparator is the thousands separator (ie, ‘.’, ‘,’).
decimalstringdecimal is the decimal character (ie, ‘.’, ‘,’).
digitsint32digits are the number of significant digits to display after the decimal.
show_digitsboolshow_digits dictates how to display
cformatstringcformat is a C-compatible formatting string (ie, ‘$%d.%d’, ‘Rp. %d,%d’).
cformat_shortstringcformat_short is the C-compatible formatting string to display the short format (ie, ‘$%d’, ‘Rp. %d’).

EchoMessage

EchoMessage is an echo message.

FieldTypeLabelDescription
msgstringmsg is the content to echo.

FieldInfo

FieldInfo contains information pertaining to a form field.

FieldTypeLabelDescription
field_numuint32field_num is the field number (ie, ordinal position).
typeType
namestringname is the name of the field.
titlestringtitle is the displayable title of the field.
valuestringvalue is the value of the field (if the field needs to be prepopulated).
optionsOptionsEntryrepeatedoptions are the options name value pairs for radio, check and select field types.
help_textHelpTextEntryrepeatedhelp contains a key, value pair of help text to be interpreted by the UI as necessary.
error_textErrorTextEntryrepeatederror_text contains the key, value pair of error text to be interpretted by the UI as necessary.
extrastringextra contains raw data to be interpreted by the field.
editablebooleditable is whether or not the field can be changed by the user.

ErrorTextEntry

FieldTypeLabelDescription
keystring
valuestring

HelpTextEntry

FieldTypeLabelDescription
keystring
valuestring

OptionsEntry

FieldTypeLabelDescription
keystring
valuestring

Filter

Filter contains the filter information for a single field.

FieldTypeLabelDescription
operationstringcomparison operation.
filter_termstringfilter_term is the input to the filter comparison.

FilterField

FilterField contains the filtering information for a single field.

FieldTypeLabelDescription
namestringname is the name of the data field being filtered.
filterFilterrepeatedfilter are the filtering operations to be applied to the field.

FilterSet

FilterSet contains a set of filters to be applied together.

FieldTypeLabelDescription
fieldsFilterFieldrepeatedfields contains the filtering for each filtered field.

FormInfo

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

FieldTypeLabelDescription
typeTypetype is the form type.
stepuint32step is the 0..N state step number.
namestringname is the current step name.
titlestringtitle contains the displayable title of the form.
help_textHelpTextEntryrepeatedhelp contains a key, value pair of help text to be interpreted by the UI as necessary.
error_textErrorTextEntryrepeatederror_text contains the key, value pair of error text to be interpretted by the UI as necessary.
button_titlestringbutton_title is the text that should be displayed as the text for the form’s submission button.
fieldsFieldInforepeatedfields are the fields that need to be collected for the current state.

ErrorTextEntry

FieldTypeLabelDescription
keystring
valuestring

HelpTextEntry

FieldTypeLabelDescription
keystring
valuestring

Match

FieldTypeLabelDescription
match_idstringmatch_id is the unique match identifier.
short_idstringshort_id is the short match id.
account_idstringaccount_id is the account where the deposit is expected.
statusMatchStatusstatus is the match status.
dateTimestampdate is the creation timestamp.
expiryTimestampexpiry is the match expiration timestamp.
from_accountAccountDescfrom_account is the debit account information.
memo_codestringmemo_code is the match identifier.
totalAmounttotal is the total amount to be matched.
notestringnote is an optional user-defined field.
settledTimestampsettled is the timestamp when the settling transaction was matched.
final_matchTransactionMatchfinal_match is the final match with a transaction.
possible_matchesPossibleMatchesEntryrepeatedid to TransactionMatch.

PossibleMatchesEntry

FieldTypeLabelDescription
keystring
valueTransactionMatch

MetaResponse

MetaResponse is the metadata response.

FieldTypeLabelDescription
countriesCountryrepeatedcountries is the list of countries.
banksBankrepeatedbanks is the list of banks.
currenciesCurrencyrepeatedcurrencies is the list of currencies.

Profile

Profile is the user’s profile information.

FieldTypeLabelDescription
namestringname is the user’s name.
langstringlang is the user’s language code (en, id, …).
countrystringcountry is the user’s country code (ID, US, SG, …).
profile_idstringprofile_id is the user’s profile identifier.

ResourceInfo

ResourceInfo contains general web resource information.

FieldTypeLabelDescription
typeType
token_typestringtoken_type is the token type for use with oauth2.
tokenstringtoken is the authorization token.
base_urlstringbase_url is the base url for the resource.
auth_urlstringauth_url is the oauth2 authorization url.
token_urlstringtoken_url is the oauth2 token url.

Transaction

Transaction contains information for a specific transaction.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.
match_idstringmatch_id is the related match identifier (if any).
from_accountstringfrom_account is the account number of the debited account (if any).
account_idstringaccount_id is the account identifier of the credited account.
descriptorstringdescriptor is the bank statement descriptor.
dateTimestampdate is the transaction date.
amountAmountamount is the transaction amount.
typeTypetype is the type of bank transaction (DEBIT, CREDIT, TRANSFER)
pendingboolpending is a flag for transactions marked by the bank as pending.

TransactionMatch

FieldTypeLabelDescription
transaction_idstringtransaction_id is the id of the transaction record.
match_strengthfloatmatch_strength is the overall match strength estimate. Its range is [0, 1].
fieldsFieldsEntryrepeatedfields is a map of { field_name : stregth } for each entry in the matching breakdown.

FieldsEntry

FieldTypeLabelDescription
keystring
valuefloat

Type

Type is the account type enum.

NameDescription
UNKNOWN
CHECKING
SAVINGS

Type

Type is the account info type enum.

NameDescription
UNKNOWN
ACCOUNT
PROFILE
BANK
MSISDN

BankCode

BankCode is the bank code enum type.

NameDescription
UNKNOWN_BANK
MANDIRI
BCA
BNI
BRI

OkStatus

OkStatus is a the generic OK status enum.

NameDescription
UNKNOWN
ERROR
OK

Type

Type is the credential type enum.

NameDescription
UNKNOWN
MSISDN
EMAIL
TOKEN

Type

Type is the field type enum.

NameDescription
EMPTY
TEXT
RADIO
CHECK
SELECT
CAPTCHA
AMOUNT

Type

Type is the form type enum type.

NameDescription
UNKNOWN
ERROR
INPUT
COMPLETE

MatchStatus

MatchStatus is the match status enum type.

NameDescription
OPEN
READY
SETTLED
CANCELLED
EXPIRED

Type

Type is the resource type enum.

NameDescription
NONE
BRANKAS_V2
FIRESTORE_V1

SuccessStatus

SuccessStatus is a the success status enum type.

NameDescription
UNKNOWN
ERROR
SUCCESS

Type

NameDescription
UNKNOWN
DEBIT
CREDIT
TRANSFER

Package Namespace brankas.v2.bank

CreateBankCredentialRequest

CreateBankCredentialRequest holds the create bank credential request information.

FieldTypeLabelDescription
bank_codeBankCodebank_code is the bank code (MANDIRI, BCA, etc).
credentialCredentialcredential is the encrypted credential.
titlestringtitle is optional title to associate with the bank credential.

CreateBankCredentialResponse

CreateBankCredentialResponse holds the create bank credential response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the result of the reqest.
bankcredential_idstringbankcredential_id is the created credential id.

DeleteBankCredentialRequest

DeleteBankCredentialRequest holds the delete bank credential request information.

FieldTypeLabelDescription
bankcredential_idstringbankcredential_id is the credential id to delete.

DeleteBankCredentialResponse

DeleteBankCredentialResponse holds the delete bank credential response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the success status of the request.

Package Namespace brankas.v2.match

CancelMatchRequest

CancelMatchRequest holds the cancel match request information.

FieldTypeLabelDescription
match_idstringmatch_id is the created match id.

CancelMatchResponse

CancelMatchResponse holds the cancel match response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the result status of the request.

CreateMatchRequest

CreateMatchRequest holds the create match request information.

FieldTypeLabelDescription
fromAccountDescfrom is the from account information.
account_idstringaccount_id is the account identifier for the account to expect the transaction.
amountAmountamount is the payment amount.
memostringmemo is the user supplied short transaction memo.
expiryTimestampexpiry is the deadline for matching a transaction for payment.
notestringnote is an optional user-defined field.

CreateMatchResponse

CreateMatchResponse holde the create match response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the result status of the request.
match_idstringmatch_id is the unique match identifier.
short_idstringshort_id is the short match id.

GetMatchRequest

GetMatchRequest holds the get match request information.

FieldTypeLabelDescription
match_idstringmatch_id is the unique match identifier.

GetMatchResponse

GetMatchResponse holds the get match response information.

FieldTypeLabelDescription
matchMatchmatch is the returned match information.

GetMatchesRequest

GetMatchesRequest holds the list of get matches request information.

FieldTypeLabelDescription
idsGetMatchRequestrepeated

GetMatchesResponse

GetMatchesResponse holds the list of get matches response information.

FieldTypeLabelDescription
matchesMatchrepeated

UpdateMatchRequest

UpdateMatchRequest holds the update match request information.

FieldTypeLabelDescription
match_idstringmatch_id is the unique match identifier.
amountAmountamount is the payment amount.
expiryTimestampexpiry is the deadline for matching a transaction for payment.
notestringnote is an optional user-defined field.

UpdateMatchResponse

UpdateMatchResponse holde the update match response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the result status of the request.

Package Namespace brankas.v2.profile

LoginRequest

LoginRequest holds the login request information.

FieldTypeLabelDescription
user_agentstringuser_agent is the client user agent.
credentialCredentialcredential is the credential to to use to complete the login.

LoginResponse

LoginResponse holds the login response information.

FieldTypeLabelDescription
statusClientStatusstatus is the client status.
extrastringextra contains additional information if the login failed.
resourcesResourcesEntryrepeatedresources are the avaliable resources.

map keys are the same as the ResourceInfo.Type. |

ResourcesEntry

FieldTypeLabelDescription
keystring
valueResourceInfo

RegisterRequest

RegisterRequest holds the register request information.

FieldTypeLabelDescription
user_agentstringuser_agent is the client user agent.
credentialCredentialcredential is the initial credential to assign with the profile.
profileProfileprofile is the user’s initial profile information.

RegisterResponse

RegisterResponse holds the register response information.

FieldTypeLabelDescription
statusClientStatusstatus is the client status.
extrastringextra contains additional information if the registration failed.
tokenstringtoken is the token to use with the verify credential request.

UpdateRequest

UpdateRequest holds the update request information.

FieldTypeLabelDescription
profile_idstringprofile_id is the user’s profile identifier.
profileProfileprofile is the updated profile information.

UpdateResponse

UpdateResponse holds the update response information.

FieldTypeLabelDescription
statusClientStatusstatus is the client status.

ClientStatus

ClientStatus is the client status enum.

NameDescription
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.

FieldTypeLabelDescription
purposeTFAPurposepurpose defines what this TFA token should be used for.
purpose_idstringid will be a bankcredential_id.
tokenstringtoken is the actual TFA token string.

SendTFAResponse

SendTFAResponse holds the two-factor authentication response.

FieldTypeLabelDescription
statusSuccessStatusstatus is the success status of the request.
auth_statusStatusauth_status is the authentication status.
status_msgstringstatus_msg is the bank status message.

Status

NameDescription
UNKNOWN
INCOMPLETE
COMPLETE

TFAPurpose

NameDescription
UnknownPurpose
BankCredentialLogin

Package Namespace brankas.v2.transaction

AdvanceTransactionRequest

AdvanceTransactionRequest holds the advance transaction request information.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.
dataFormInfodata is the chat state data needed to advance the transaction.

AdvanceTransactionResponse

AdvanceTransactionResponse holds the advance transaction response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the success status of the request.
dataFormInfodata is the chat state data if there was an error.

CreateTransactionRequest

CreateTransactionRequest holds the create transaction request information.

FieldTypeLabelDescription
account_idstringaccount_id is the from account identifier.
toAccountDescto is the to account information.
amountAmountamount is the transaction amount.
memostringmemo is the user supplied short transaction memo.

CreateTransactionResponse

CreateTransactionResponse holds the create transaction response information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the result status of the request.
transaction_idstringtransaction_id is the created transaction id.
short_idstringshort_id is the short transaction id.
urlstringurl is the URL for sharing the transaction with a user.

DeleteTransactionRequest

DeleteTransactionRequest holds the delete transaction request information.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.

DeleteTransactionResponse

DeleteTransactionResponse holds the delete transaction request information.

FieldTypeLabelDescription
statusSuccessStatusstatus is the success status of the request.

GetTransactionRequest

GetTransactionRequest holds the get transaction request information.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.

GetTransactionResponse

GetTransactionResponse holds the get transaction response information.

FieldTypeLabelDescription
transactionTransaction

GetTransactionsRequest

GetTransactionsRequest holds the get transaction request information.

FieldTypeLabelDescription
idsGetTransactionRequestrepeatedids is the list of transaction ids.
sinceTimestampsince is the oldest transaction to fetch.
max_countuint32max_count is the maximum number of transactions to fetch.

GetTransactionsResponse

GetTransactionsResponse holds the get transaction response information.

FieldTypeLabelDescription
transactionsTransactionrepeatedtransactions is the list of transactions.
credits_totalAmountrepeatedcredits_total is the sum total of all deposit transactions
debits_totalAmountrepeateddebits_total is the sum total of all deposit transactions

PollTransactionRequest

PollTransactionRequest holds the poll transaction request information.

FieldTypeLabelDescription
transaction_idstringtransaction_id is the transaction id.

PollTransactionResponse

PollResponse holds the poll chat response information.

FieldTypeLabelDescription
statusStatusstatus is the current status of the transaction.
dataFormInfodata contains the current form data of the transaction.

Status

Status is the poll chat status enum type.

NameDescription
NONE
WAITING
READY
ERROR

Subscribe to our newsletterLeave your name and email below to recieve updates about Brankas. We value your privacy and will never share your details.

Try Brankas today!Leave your name and email below and we will contact shortly to demonstrate how Brankas can help your organization.

We'll get in contact with you soon

Thank You

We'll get in contact with you soon!