AccountService
AccountService provides all the methods for retrieving and summarizing account information.
RetrieveAccount
RetrieveAccount retrieves the account information for a single account.
GET /v2/account/{account_id}
RetrieveAccountRequest
RetrieveAccountRequest holds the get account request information.
Field | Type | Label | Description |
---|---|---|---|
account_id | string | account_id is the account unique identifier. |
RetrieveAccountResponse
RetrieveAccountResponse 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. |
RetrieveAccounts
RetrieveAccounts retrieves the list of all accounts registered to the brankas service.
GET /v2/account
RetrieveAccountsResponse
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.
PUT /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.Status | status defines the result of the request. |
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)}
curl https://a.brank.as/v2/status
CheckStatusResponse
CheckStatusResponse contains information about the underlying system status.
{ "status": "OK" }
Field | Type | Label | Description |
---|---|---|---|
status | CheckStatusResponse.OkStatus | status defines the result 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/confirmcode
ConfirmationCodeRequest
ConfirmationCodeRequest contains the confirmation code reqest.
Field | Type | Label | Description |
---|---|---|---|
invite_code | string | invite_code is the alphanumeric invite code. | |
string | email is the confirmation email address. |
Login
Login validates user account authorization.
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 that can be used to access Brankas APIs. | |
resources | LoginResponse.ResourcesEntry | repeated | resources is for internal use only. There are no compatibility promises for any resources field. |
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. |
CredentialService
CredentialService provides all the methods for creating, retrieving, and manipulating bank credentials.
CreateCredential
CreateCredential creates a new bank credential entry for the specified bank code.
POST /v2/bankcredential
CreateCredentialRequest
CreateCredentialRequest holds the create bank credential request information.
Field | Type | Label | 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. |
CreateCredentialResponse
CreateCredentialResponse holds the create bank credential response information.
Field | Type | Label | Description |
---|---|---|---|
status | brankas.v2.api.Status | status defines the result of the request. | |
credential_id | string | credential_id is the created credential id. |
DeleteCredential
DeleteCredential deletes a bank credential.
DELETE /v2/bankcredential/{credential_id}
DeleteCredentialRequest
DeleteCredentialRequest holds the delete bank credential request information.
Field | Type | Label | Description |
---|---|---|---|
credential_id | string | credential_id is the credential id to delete. |
DeleteCredentialResponse
DeleteCredentialResponse holds the delete bank credential response information.
Field | Type | Label | Description |
---|---|---|---|
status | brankas.v2.api.Status | status defines the result of the request. |
DisbursementService
DisbursementService provides methods for disbursing funds and retrieving disbursements
CreateBankCredential
CreateBankCredential creates a partial credential for a client on a bank. This way, the client’s calls to CreateDisbursement will only need to contain their ‘credential.secret’, and won’t need to include their ‘credential.identifier’ and ‘disbursement.corporate_id’.
POST /v2/bankcredential
CreateBankCredentialRequest
CreateBankCredentialRequest is used to create a partial credential for a client on a bank
Field | Type | Label | Description |
---|---|---|---|
bank_credential | BankCredential | bank_credential to create |
CreateBankCredentialResponse
CreateBankCredentialResponse returns whether the bank credential was created successfully or not
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response |
CreateDisbursements
CreateDisbursement will initiate a new disbursement to transfer funds from one account to another
POST /v2/disbursements
CreateDisbursementsRequest
CreateDisbursementsRequest will initiate disbursement payments to merchants clients
Field | Type | Label | Description |
---|---|---|---|
credentials | CreateDisbursementsRequest.CredentialsEntry | repeated | API’ |
disbursements | Disbursement | repeated | disbursements is the disbursements to attempt to create |
CreateDisbursementsResponse
CreateDisbursementsResponse returns the result of a disbursements transaction
Field | Type | Label | Description |
---|---|---|---|
result | DisbursementResult | repeated | result will return a success or error message for the response for each disbursement |
DeleteBankCredential
DeleteBankCredential deletes a partial credential for a client on a bank
DELETE /v2/bankcredential/{bankcredentialtype}
DeleteBankCredentialRequest
DeleteBankCredentialRequest will delete a partial credential for a client on a bank
Field | Type | Label | Description |
---|---|---|---|
type | string | type for which bank_credential to delete |
DeleteBankCredentialResponse
DeleteBankCredentialResponse returns whether the bank credential was deleted
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response |
ProcessFutureDisbursements
PrcocessFutureDisbursements will send all the saved, future disbursements for a client to the bank to process
POST /v2/disbursements-process
ProcessFutureDisbursementsRequest
ProcessFutureDisbursementsRequest will start processing stored disbursements
Field | Type | Label | Description |
---|---|---|---|
credentials | ProcessFutureDisbursementsRequest.CredentialsEntry | repeated | API’ |
disbursement_ids | string | repeated | disbursement_ids are a list of future disbursements that should be processed now |
ProcessFutureDisbursementsResponse
ProcessFutureDisbursementResponse will return the results of processing stored disbursements
Field | Type | Label | Description |
---|---|---|---|
result | DisbursementResult | repeated | result will return a success or error message for the response for each disbursement |
RetrieveBankCredentials
RetrieveBankCredentials will return all the bank credentials for a client
GET /v2/bankcredential
RetrieveBankCredentialsResponse
RetrieveBankCredentialsResponse returns all the bank credentials for a client
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response | |
bank_credentials | BankCredential | repeated | bank_credentials are all the stored BankCredential’s we have for a client |
RetrieveDisbursements
RetrieveDisbursements will return all the disbursements for a given date range
GET /v2/disbursements
RetrieveDisbursementsRequest
RetrieveDisbursementsRequest is used to get a list of disbursements that match the list of disbursement ids, and that fall between the startdate and enddate. If startdate or enddate isn’t specified, all disbursements matching the disbursement ids are returned
Field | Type | Label | Description |
---|---|---|---|
disbursement_ids | string | repeated | disbursement_ids are a list of disbursement ids to return disbursements for |
start_date | Date | start_date is the start date of the range inclusive of the date | |
end_date | Date | end_date is the end date of the range inclusive of the date |
RetrieveDisbursementsResponse
RetrieveDisbursementsResponse returns a list of disbursements that fall inside the date range
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response | |
disbursements | Disbursement | repeated | disbursements are the disbursements that fall within the specified date range |
UpdateBankCredential
UpdateBankCredential updates a partial credential for a client on a bank
PUT /v2/bankcredential/{bankcredentialtype}
UpdateBankCredentialRequest
UpdateBankCredentialRequest is used to update a partial credential for a client on a bank
Field | Type | Label | Description |
---|---|---|---|
type | string | type to update the bank_credential for | |
bank_credential | BankCredential | bank_credential data to update |
UpdateBankCredentialResponse
UpdateBankCredentialResponse returns whether the bank credential were updated
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response |
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.
POST /v2/match/{match_id}/cancel
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.Status | status defines the result of the request. |
CreateMatch
CreateMatch initiates a payment match.
POST /v2/match
CreateMatchRequest
CreateMatchRequest holds the create match request information.
Field | Type | Label | 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 | Label | Description |
---|---|---|---|
status | brankas.v2.api.Status | status defines the result of the request. | |
match_id | string | match_id is the unique match identifier. | |
short_id | string | short_id is the short match id. |
RetrieveMatch
RetrieveMatch retrieves the match data.
GET /v2/match/{match_id}
RetrieveMatchRequest
RetrieveMatchRequest holds the get match request information.
Field | Type | Label | Description |
---|---|---|---|
match_id | string | match_id is the unique match identifier. |
RetrieveMatchResponse
RetrieveMatchResponse holds the get match response information.
Field | Type | Label | Description |
---|---|---|---|
match | brankas.v2.api.Match | match is the returned match information. |
RetrieveMatches
RetrieveMatches retrieves the match data for a set of matches.
GET /v2/match
RetrieveMatchesRequest
RetrieveMatchesRequest holds the list of get matches request information.
Field | Type | Label | Description |
---|---|---|---|
ids | RetrieveMatchRequest | repeated |
RetrieveMatchesResponse
RetrieveMatchesResponse holds the list of get matches response information.
Field | Type | Label | Description |
---|---|---|---|
matches | brankas.v2.api.Match | repeated |
UpdateMatch
UpdateMatch updates the match data.
PUT /v2/match/{match_id}
UpdateMatchRequest
UpdateMatchRequest holds the update match request information.
Field | Type | Label | 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.Status | status defines the result of the request. |
OrgService
OrgService provides organization management.
CreateOrg
CreateOrg registers a new organization.
POST /v2/org
CreateOrgRequest
CreateOrgRequest holds the information to register an organization.
Field | Type | Label | Description |
---|---|---|---|
user_agent | string | user_agent is the client user agent. | |
org | brankas.v2.api.OrgProfile | org is the organization information. |
CreateOrgResponse
CreateOrgResponse holds the response from registering an organization.
Field | Type | Label | Description |
---|---|---|---|
status | OrgStatus | status defines the result of the request. | |
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. |
RetrieveOrg
RetrieveOrg fetches the organization information.
GET /v2/org/{org_id}
RetrieveOrgRequest
RetrieveOrgRequest holds the get org request search parameters.
Field | Type | Label | Description |
---|---|---|---|
org_id | string | org_id is the organization identifier |
RetrieveOrgResponse
RetrieveOrgResponse holds the org information.
Field | Type | Label | Description |
---|---|---|---|
org | brankas.v2.api.OrgProfile | org is the organization information. | |
settings | brankas.v2.api.OrgSettings | settings is the organization settings. |
UpdateOrg
UpdateOrg updates organization data.
PUT /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. | |
settings | brankas.v2.api.OrgSettings | settings is the organization settings. |
UpdateOrgResponse
UpdateOrgResponse holds the update organization information.
Field | Type | Label | Description |
---|---|---|---|
status | OrgStatus | status defines the result of the request. |
UserService
UserService allows managing organization users, such as the employees working for a company.
CreateUser
CreateUser registers a new organization user.
POST /v2/orguser
CreateUserRequest
CreateUserRequest holds the information to register an organization user.
Field | Type | Label | 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. |
CreateUserResponse
CreateUserResponse holds the response from registering an organization user.
Field | Type | Label | Description |
---|---|---|---|
status | ProfileStatus | status defines the result of the request. | |
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 UpdateUser. |
RetrieveUsers
RetrieveUsers fetches all orgUsers matching the search parameters. Search is restricted to the authenticated organization.
GET /v2/orguser
RetrieveUserRequest
RetrieveUserRequest holds the parameters to retrieve an organization user.
Field | Type | Label | Description |
---|---|---|---|
search_fields | brankas.v2.api.Profile | search_fields holds search parameters. |
RetrieveUserResponse
RetrieveUserResponse holds the matching organization users.
Field | Type | Label | Description |
---|---|---|---|
profiles | brankas.v2.api.Profile | repeated | profiles is the list of profiles. |
UpdateUser
UpdateUser updates orgUser data.
PUT /v2/orguser/{user_id}
UpdateUserRequest
UpdateUserRequest holds the information to update an existing organization user.
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. |
UpdateUserResponse
UpdateUserResponse holds the response from updating an organization user.
Field | Type | Label | Description |
---|---|---|---|
status | ProfileStatus | status defines the result of the request. |
ServiceTokenService
ServiceTokenService provides service token management for organizations.
CreateServiceToken
CreateServiceToken creates a new service token.
POST /v2/servicetoken
CreateServiceTokenRequest
CreateServiceTokenRequest holds the service token creation information
Field | Type | Label | Description |
---|---|---|---|
expiry | google.protobuf.Timestamp | expiry is the expiry timestamp |
CreateServiceTokenResponse
CreateServiceTokenResponse holds the response from creating a service token.
Field | Type | Label | Description |
---|---|---|---|
token_id | string | token_id is the id of the token created. | |
credential | brankas.v2.api.Credential | credential contains the created token. |
DeleteServiceToken
DeleteServiceToken deletes a service token.
DELETE /v2/servicetoken/{token_id}
DeleteServiceTokenRequest
DeleteServiceTokenRequest holds a request to delete a service token.
Field | Type | Label | Description |
---|---|---|---|
token_id | string | token_id is the id of the token to be deleted. |
RetrieveServiceTokens
RetrieveServiceTokens retrieves the service tokens associated with an organization.
GET /v2/servicetoken
RetrieveServiceTokensRequest
RetrieveServiceTokensRequest holds the request for the list of service tokens associated with an org. TODO: add scopes for filtering
RetrieveServiceTokensResponse
RetrieveServiceTokensResponse holds the list of tokens associated with an org.
Field | Type | Label | Description |
---|---|---|---|
token_list | TokenMetadata | repeated | token_list contains the metadata of the tokens associated with the org. |
StatementService
StatementService provides all methods to fetch bank or accounts statement.
RetrieveStatements
RetrieveStatement retrieves summary of financial transactions which have occurred over a given period.
GET /v2/statement
RetrieveStatementsRequest
RetrieveStatementRequest holds the get request information
Field | Type | Label | Description |
---|---|---|---|
bank_code | brankas.v2.api.BankCode | bank_code is the bank code (MANDIRI, BCA, etc). | |
credential | brankas.v2.api.Credential | credential is the internet banking account credential. | |
period_days | int32 | period_days is the filter to search transactions that occurred over a given period. note: the behaviour of the search is depends upon each bank site. |
RetrieveStatementsResponse
RetrieveStatementRespones hold the get statement response information.
Field | Type | Label | Description |
---|---|---|---|
statement_id | string | statement_id is the unique identifier for the statement request. | |
status | StatementStatus | status is the statement request 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 | Label | 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 | Label | Description |
---|---|---|---|
status | brankas.v2.api.Status | status defines the result of the request. | |
auth_status | SendTFAResponse.Status | auth_status defines the result of the request. | |
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.Status | status defines the result 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 | Label | 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 | Label | Description |
---|---|---|---|
status | brankas.v2.api.Status | status defines the result 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.Status | status defines the result of the request. |
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 defines the result of the request. | |
data | brankas.v2.api.FormInfo | data contains the current form data of the transaction. |
RetrieveTransaction
RetrieveTransaction retrieves transaction information.
GET /v2/transaction/{transaction_id}
RetrieveTransactionRequest
RetrieveTransactionRequest holds the get transaction request information.
Field | Type | Label | Description |
---|---|---|---|
transaction_id | string | transaction_id is the transaction id. |
RetrieveTransactionResponse
RetrieveTransactionResponse holds the get transaction response information.
Field | Type | Label | Description |
---|---|---|---|
transaction | brankas.v2.api.Transaction |
RetrieveTransactions
RetrieveTransactions retrieves a set of transactions.
GET /v2/transaction
RetrieveTransactionsRequest
RetrieveTransactionsRequest holds the get transaction request information.
Field | Type | Label | Description |
---|---|---|---|
ids | RetrieveTransactionRequest | 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. |
RetrieveTransactionsResponse
RetrieveTransactionsResponse 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 |
Datatypes
Package Namespace brankas.v2.account
RetrieveAccountRequest
RetrieveAccountRequest holds the get account request information.
Field | Type | Label | Description |
---|---|---|---|
account_id | string | account_id is the account unique identifier. |
RetrieveAccountResponse
RetrieveAccountResponse 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. |
RetrieveAccountsResponse
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 | Status | status defines the result of the request. |
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 | Label | 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 | Label | 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 | Label | 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 | Label | 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 defines the result 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 | Label | 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 | Label | 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 | Label | 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 defines the result of the request. | |
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 | Label | 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. | |
string | email is the organization contact email. | ||
phone | string | phone is the organization phone number. |
OrgSettings
OrgSettings is the organization cutomization settings.
Field | Type | Label | Description |
---|---|---|---|
statement_webhook | string | statement_webhook is the organization webhook url for statement events. | |
match_webhook | string | match_webhook is the organization webhook url for match events. |
Profile
Profile is the user’s profile information.
Field | Type | Label | 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 | Label | 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. |
Statement
Statement contains the summary of the financial transactions which have occurred over a given period on a bank account.
Field | Type | Label | Description |
---|---|---|---|
account_number | string | account_number is the account number. | |
ending_balance | Amount | ending_balance is the ending balance for this period. | |
transactions | Transaction | repeated | transactions is the list of transaction which occured over the specified period. |
name | string | name is the full name of the owner of the bank account. The format may change between banks. |
Transaction
Transaction contains information for a specific transaction.
Field | Type | Label | 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 | |
DUMMY_BANK | |
MANDIRI_PERSONAL | |
BCA_PERSONAL | |
BNI_PERSONAL | |
BRI_PERSONAL | |
BCA_ENTERPRISE | |
PERSONAL | Used in endtoend testing. |
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 | |
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 |
Status
Status is an enum type defining whether an operation succeeded.
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. | |
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 that can be used to access Brankas APIs. | |
resources | ResourcesEntry | repeated | resources is for internal use only. There are no compatibility promises for any resources field. |
ResourcesEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
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
CreateCredentialRequest
CreateCredentialRequest holds the create bank credential request information.
Field | Type | Label | 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. |
CreateCredentialResponse
CreateCredentialResponse holds the create bank credential response information.
Field | Type | Label | Description |
---|---|---|---|
status | Status | status defines the result of the request. | |
credential_id | string | credential_id is the created credential id. |
DeleteCredentialRequest
DeleteCredentialRequest holds the delete bank credential request information.
Field | Type | Label | Description |
---|---|---|---|
credential_id | string | credential_id is the credential id to delete. |
DeleteCredentialResponse
DeleteCredentialResponse holds the delete bank credential response information.
Field | Type | Label | Description |
---|---|---|---|
status | Status | status defines the result of the request. |
Package Namespace brankas.v2.disbursement
BankAccountInfo
BankAccountInfo contains information relating to a bank account
Field | Type | Label | Description |
---|---|---|---|
bank | BankCode | bank is which bank the bank account is for | |
number | string | number is the bank account number | |
holder_name | string | holder_name is the name of the owner of the bank account | |
type | BankAccountType | type is the type of bank account |
BankCredential
BankCredential is the credential used to access a banks API. Some banks will require multiple different BankCredential’s which can be seperated by the ‘type’ field.
Field | Type | Label | Description |
---|---|---|---|
corporate_id | string | corporate_id is the banks unique id for the organization | |
identifier | string | identifier is the unique identifier for the credential | |
secret | string | secret is the secret for the credential | |
type | BankCredentialType | type defines what bank this credential will be used for, and how the credential will be used with the bank |
CreateBankCredentialRequest
CreateBankCredentialRequest is used to create a partial credential for a client on a bank
Field | Type | Label | Description |
---|---|---|---|
bank_credential | BankCredential | bank_credential to create |
CreateBankCredentialResponse
CreateBankCredentialResponse returns whether the bank credential was created successfully or not
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response |
CreateDisbursementsRequest
CreateDisbursementsRequest will initiate disbursement payments to merchants clients
Field | Type | Label | Description |
---|---|---|---|
credentials | CredentialsEntry | repeated | API’ |
disbursements | Disbursement | repeated | disbursements is the disbursements to attempt to create |
CredentialsEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | BankCredential |
CreateDisbursementsResponse
CreateDisbursementsResponse returns the result of a disbursements transaction
Field | Type | Label | Description |
---|---|---|---|
result | DisbursementResult | repeated | result will return a success or error message for the response for each disbursement |
Date
Date indicates a specific date
Field | Type | Label | Description |
---|---|---|---|
year | int32 | Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. | |
month | int32 | Month of year. Must be from 1 to 12. | |
day | int32 | Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant. |
DeleteBankCredentialRequest
DeleteBankCredentialRequest will delete a partial credential for a client on a bank
Field | Type | Label | Description |
---|---|---|---|
type | string | type for which bank_credential to delete |
DeleteBankCredentialResponse
DeleteBankCredentialResponse returns whether the bank credential was deleted
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response |
Disbursement
Disbursement contains data for a disbursement
Field | Type | Label | Description |
---|---|---|---|
corporate_id | string | corporate_id is the banks unique id for the organization | |
reference_id | string | reference_id is a reference from the merchant to uniquely identify a disbursement transaction, this should be an idempotent value | |
type | Type | type is the type of disbursement being created | |
source_account | BankAccountInfo | source_account is the account to send payment from | |
destination_account | BankAccountInfo | destination_account is the account to send payment to | |
source_amount | Amount | amount.num’ should be in the lowest denomination for a currency. This will be generated by Brankas system. | |
destination_amount | Amount | amount.num’ should be in the lowest denomination for a currency | |
exchange_rate | string | exchange_rate is the foreign exchange rate (if applicable) of the disbursement. Set exchange_rate to be 1.0 if the source and destination currency are the same. | |
fees | Fees | fees are the associated fees for the disbursement | |
description | string | description is what the destination account will see for the disbursement transaction | |
disbursement_id | string | disbursement_id is an id brankas uniquely generates for this disbursement | |
id | string | id is the reference id returned from the bank’s api to uniquely identify a disbursement in their system. | |
status | Status | status defines the result of the request. | |
created | Timestamp | created is a timestamp indicating when the disbursement was created | |
updated | Timestamp | updated is a timestamp indicating when the disbursement was last updated | |
processed | Timestamp | processed is a timestamp indicating when the disbursement was sent to the bank, this will be used to determine what disbursements should be returned from the RetrieveDisbursements request |
DisbursementResult
DisbursementResult is a disbursement plus it’s response from the bank, the disbursement was created with
Field | Type | Label | Description |
---|---|---|---|
disbursement | Disbursement | disbursement is the disbursement that was created with the bank | |
result | Result | result is the repsonse from the bank when trying to create the disbursement |
Error
Error is the message if the result is not successful.
Field | Type | Label | Description |
---|---|---|---|
code | string | ||
message | string |
Fee
Fee is the associated data for a particular fee
Field | Type | Label | Description |
---|---|---|---|
name | string | name is the name of the fee | |
amount | string | amount is the amount of the fee |
Fees
Fees are a list of fees that are charged for a disbursement
Field | Type | Label | Description |
---|---|---|---|
fee | Fee | repeated |
ProcessFutureDisbursementsRequest
ProcessFutureDisbursementsRequest will start processing stored disbursements
Field | Type | Label | Description |
---|---|---|---|
credentials | CredentialsEntry | repeated | API’ |
disbursement_ids | string | repeated | disbursement_ids are a list of future disbursements that should be processed now |
CredentialsEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | BankCredential |
ProcessFutureDisbursementsResponse
ProcessFutureDisbursementResponse will return the results of processing stored disbursements
Field | Type | Label | Description |
---|---|---|---|
result | DisbursementResult | repeated | result will return a success or error message for the response for each disbursement |
Result
Result is a response result with whether the response is a success or what the error was
Field | Type | Label | Description |
---|---|---|---|
success | bool | ||
error | Error | repeated |
RetrieveBankCredentialsResponse
RetrieveBankCredentialsResponse returns all the bank credentials for a client
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response | |
bank_credentials | BankCredential | repeated | bank_credentials are all the stored BankCredential’s we have for a client |
RetrieveDisbursementsRequest
RetrieveDisbursementsRequest is used to get a list of disbursements that match the list of disbursement ids, and that fall between the startdate and enddate. If startdate or enddate isn’t specified, all disbursements matching the disbursement ids are returned
Field | Type | Label | Description |
---|---|---|---|
disbursement_ids | string | repeated | disbursement_ids are a list of disbursement ids to return disbursements for |
start_date | Date | start_date is the start date of the range inclusive of the date | |
end_date | Date | end_date is the end date of the range inclusive of the date |
RetrieveDisbursementsResponse
RetrieveDisbursementsResponse returns a list of disbursements that fall inside the date range
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response | |
disbursements | Disbursement | repeated | disbursements are the disbursements that fall within the specified date range |
UpdateBankCredentialRequest
UpdateBankCredentialRequest is used to update a partial credential for a client on a bank
Field | Type | Label | Description |
---|---|---|---|
type | string | type to update the bank_credential for | |
bank_credential | BankCredential | bank_credential data to update |
UpdateBankCredentialResponse
UpdateBankCredentialResponse returns whether the bank credential were updated
Field | Type | Label | Description |
---|---|---|---|
result | Result | result will return a success or error message for the response |
BankAccountType
BankAccountType indicates which account to use
Name | Description |
---|---|
ACCOUNT | |
CHECKINGS | |
SAVINGS |
BankCode
BankCode indicates which bank to use; these should be a list of banks that we are currently integrated with This is the updated list of banks per January 2018
Name | Description |
---|---|
CODE | |
BRANKAS_TEST | This is a dummy bank that will return static data |
BI | 001 |
BRI | 002 |
BEI | 003 |
MANDIRI | 008 |
BNI | 009 |
DANAMON | 011 |
PERMATA | 013 |
BCA | 014 |
MAYBANK | 016 |
PANIN | 019 |
CIMB | 022 |
UOB | 023 |
OCBC_NISP | 028 |
CITIBANK | 031 |
CHASE | 032 |
AMERICA | 033 |
CCB | 036 |
AGI | 037 |
BANGKOK | 040 |
HSBC | 041 |
TOKYO | 042 |
SMBC | 045 |
DBS | 046 |
RESONA | 047 |
MIZUHO | 048 |
STANDARD_CHARTERED | 050 |
RBS | 052 |
CAPITAL | 054 |
BNP_PARIBAS | 057 |
RABOBANK | 060 |
ANZ | 061 |
DEUTSCHE | 067 |
CHINA | 069 |
BUMI_ARTA | 076 |
EKONOMI_RAHARJA | 087 |
ANDA | 088 |
HAGA | 089 |
IFI | 093 |
JTRUST | 095 |
MAYAPADA | 097 |
JABAR | 110 |
DKI | 111 |
YOGYAKARTA | 112 |
JATENG | 113 |
JATIM | 114 |
JAMBI | 115 |
ACEH | 116 |
SUMUT | 117 |
NAGARI | 118 |
RIAU | 119 |
SUMSEL_BABEL | 120 |
LAMPUNG | 121 |
KALSEL | 122 |
KALBAR | 123 |
KALTIM | 124 |
KALTENG | 125 |
SULSEL | 126 |
SULUT | 127 |
NTB | 128 |
BALI | 129 |
NTT | 130 |
MALUKU | 131 |
PAPUA | 132 |
BENGKULU | 133 |
SULTENG | 134 |
SULTRA | 135 |
BNP | 145 |
INDIA | 146 |
MUAMALAT | 147 |
MESTIKA | 151 |
SHINHAN | 152 |
SINARMAS | 153 |
MASPION | 157 |
HAGAKITA | 159 |
GANESHA | 161 |
ICBC | 164 |
HARMONI | 166 |
QNB | 167 |
BTN | 200 |
WOORI | 212 |
BTPN | 213 |
VICTORIA_SYARIAH | 405 |
BRI_SYARIAH | 422 |
JABAR_SYARIAH | 425 |
MEGA | 426 |
BNI_SYARIAH | 427 |
BUKOPIN | 441 |
MANDIRI_SYARIAH | 451 |
BISNIS | 459 |
OKE | 466 |
JASA | 472 |
HANA | 484 |
MNC | 485 |
YUDHA_BHAKTI | 490 |
MITRANIAGA | 491 |
BRI_AGRONIAGA | 494 |
SBI | 498 |
ROYAL | 501 |
NATIONALNOBU | 503 |
MEGA_SYARIAH | 506 |
INA | 513 |
PANIN_SYARIAH | 517 |
PRIMA | 520 |
BUKOPIN_SYARIAH | 521 |
SAMPOERNA | 523 |
BARCLAYS | 525 |
DINAR | 526 |
AMAR | 531 |
BKE | 535 |
BCA_SYARIAH | 536 |
ARTOS | 542 |
BTPN_SYARIAH | 547 |
MULTIARTA | 548 |
MAYORA | 553 |
INDEX | 555 |
BANTEN | 558 |
CENTRATAMA | 559 |
FAMA | 562 |
MANDIRI_TASPEN | 564 |
VICTORIA | 566 |
HARDA | 567 |
PERMATA_SYARIAH | 721 |
DANAMON_SYARIAH | 722 |
BTN_SYARIAH | 723 |
DKI_SYARIAH | 724 |
JATENG_SYARIAH | 725 |
JATIM_SYARIAH | 726 |
KALBAR_SYARIAH | 727 |
KALSEL_SYARIAH | 728 |
KALTIMUT_SYARIAH | 729 |
CIMB_SYARIAH | 730 |
SYARIAH | 731 |
SUMBAR_SYARIAH | 732 |
SUMUT_SYARIAH | 733 |
SINARMAS_SYARIAH | 734 |
SULSELBAR_SYARIAH | 735 |
YOGYA_SYARIAH | 736 |
AGRIS | 945 |
MAYBANK_SYARIAH | 947 |
OCBC | 948 |
CTBC | 949 |
COMMONWEALTH | 950 |
TRANSFERWISE |
BankCredentialType
BankCredentialType is used to determine the type of ‘BankCredential’, there should be an option for every type of banks api credentials. eg: BCA require a ‘CLIENT’ and ‘API’ credential, but BNI only require a ‘CLIENT’ credential. The format for this should be ‘
Name | Description |
---|---|
CREDENTIAL_TYPE | |
CLIENT | |
BCA_CLIENT | |
BCA_API | |
BNI_CLIENT | |
TRANSFERWISE_API |
Type
Name | Description |
---|---|
UNKNOWN_TYPE | |
ON_DEMAND | on demand will process the disbursement straight away |
FUTURE | future will store the disbursement for processing at a later time |
Status
Status that a disbursement transaction could be in
Name | Description |
---|---|
UNKNOWN_STATUS | |
CREATED | |
PENDING | |
SUCCESS | |
FAILED |
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 | Status | status defines the result of the request. |
CreateMatchRequest
CreateMatchRequest holds the create match request information.
Field | Type | Label | 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 | Label | Description |
---|---|---|---|
status | Status | status defines the result of the request. | |
match_id | string | match_id is the unique match identifier. | |
short_id | string | short_id is the short match id. |
RetrieveMatchRequest
RetrieveMatchRequest holds the get match request information.
Field | Type | Label | Description |
---|---|---|---|
match_id | string | match_id is the unique match identifier. |
RetrieveMatchResponse
RetrieveMatchResponse holds the get match response information.
Field | Type | Label | Description |
---|---|---|---|
match | Match | match is the returned match information. |
RetrieveMatchesRequest
RetrieveMatchesRequest holds the list of get matches request information.
Field | Type | Label | Description |
---|---|---|---|
ids | RetrieveMatchRequest | repeated |
RetrieveMatchesResponse
RetrieveMatchesResponse 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 | Label | 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 | Status | status defines the result of the request. |
Package Namespace brankas.v2.org
CreateOrgRequest
CreateOrgRequest holds the information to register an organization.
Field | Type | Label | Description |
---|---|---|---|
user_agent | string | user_agent is the client user agent. | |
org | OrgProfile | org is the organization information. |
CreateOrgResponse
CreateOrgResponse holds the response from registering an organization.
Field | Type | Label | Description |
---|---|---|---|
status | OrgStatus | status defines the result of the request. | |
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. |
CreateUserRequest
CreateUserRequest holds the information to register an organization user.
Field | Type | Label | 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. |
CreateUserResponse
CreateUserResponse holds the response from registering an organization user.
Field | Type | Label | Description |
---|---|---|---|
status | ProfileStatus | status defines the result of the request. | |
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 UpdateUser. |
RetrieveOrgRequest
RetrieveOrgRequest holds the get org request search parameters.
Field | Type | Label | Description |
---|---|---|---|
org_id | string | org_id is the organization identifier |
RetrieveOrgResponse
RetrieveOrgResponse holds the org information.
Field | Type | Label | Description |
---|---|---|---|
org | OrgProfile | org is the organization information. | |
settings | OrgSettings | settings is the organization settings. |
RetrieveUserRequest
RetrieveUserRequest holds the parameters to retrieve an organization user.
Field | Type | Label | Description |
---|---|---|---|
search_fields | Profile | search_fields holds search parameters. |
RetrieveUserResponse
RetrieveUserResponse holds the matching organization users.
Field | Type | Label | Description |
---|---|---|---|
profiles | Profile | repeated | profiles is the list of profiles. |
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. | |
settings | OrgSettings | settings is the organization settings. |
UpdateOrgResponse
UpdateOrgResponse holds the update organization information.
Field | Type | Label | Description |
---|---|---|---|
status | OrgStatus | status defines the result of the request. |
UpdateUserRequest
UpdateUserRequest holds the information to update an existing organization user.
Field | Type | Label | Description |
---|---|---|---|
user_id | string | orgUser_id is the user’s unique identifier. | |
profile | Profile | profile is the updated profile information. |
UpdateUserResponse
UpdateUserResponse holds the response from updating an organization user.
Field | Type | Label | Description |
---|---|---|---|
status | ProfileStatus | status defines the result of the request. |
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.servicetoken
CreateServiceTokenRequest
CreateServiceTokenRequest holds the service token creation information
Field | Type | Label | Description |
---|---|---|---|
expiry | Timestamp | expiry is the expiry timestamp |
CreateServiceTokenResponse
CreateServiceTokenResponse holds the response from creating a service token.
Field | Type | Label | Description |
---|---|---|---|
token_id | string | token_id is the id of the token created. | |
credential | Credential | credential contains the created token. |
DeleteServiceTokenRequest
DeleteServiceTokenRequest holds a request to delete a service token.
Field | Type | Label | Description |
---|---|---|---|
token_id | string | token_id is the id of the token to be deleted. |
RetrieveServiceTokensRequest
RetrieveServiceTokensRequest holds the request for the list of service tokens associated with an org. TODO: add scopes for filtering
RetrieveServiceTokensResponse
RetrieveServiceTokensResponse holds the list of tokens associated with an org.
Field | Type | Label | Description |
---|---|---|---|
token_list | TokenMetadata | repeated | token_list contains the metadata of the tokens associated with the org. |
TokenMetadata
TokenMetadata holds the metadata associated with a service token.
Field | Type | Label | Description |
---|---|---|---|
token_id | string | token_id is the token id. | |
create | Timestamp | create is the creation timestamp of the token. | |
expiry | Timestamp | expiry is the expiry timestamp of the token. |
Package Namespace brankas.v2.statement
RetrieveStatementsRequest
RetrieveStatementRequest holds the get request information
Field | Type | Label | Description |
---|---|---|---|
bank_code | BankCode | bank_code is the bank code (MANDIRI, BCA, etc). | |
credential | Credential | credential is the internet banking account credential. | |
period_days | int32 | period_days is the filter to search transactions that occurred over a given period. note: the behaviour of the search is depends upon each bank site. |
RetrieveStatementsResponse
RetrieveStatementRespones hold the get statement response information.
Field | Type | Label | Description |
---|---|---|---|
statement_id | string | statement_id is the unique identifier for the statement request. | |
status | StatementStatus | status is the statement request status. |
StatementsList
StatementsList holds the statements fetched from the bank.
Sent to the organization’s registered webhook .
Field | Type | Label | Description |
---|---|---|---|
statement_id | string | statement_id is the unique identifier for the statement request. | |
status | StatementStatus | status is the statement request status. | |
error | string | error is the error message. | |
statements | Statement | repeated | statements is a summary of financial transactions which have occurred over a given period on a specified bank credentials. |
StatementStatus
StatementStatus is the status of a statment request.
Name | Description |
---|---|
RECEIVED | |
PENDING |
Package Namespace brankas.v2.tfa
SendTFARequest
SendTFARequest holds the two-factor authentication request.
Field | Type | Label | 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 | Label | Description |
---|---|---|---|
status | Status | status defines the result of the request. | |
auth_status | Status | auth_status defines the result of the request. | |
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 | Status | status defines the result 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 | Label | 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 | Label | Description |
---|---|---|---|
status | Status | status defines the result 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 | Status | status defines the result of the request. |
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 defines the result of the request. | |
data | FormInfo | data contains the current form data of the transaction. |
RetrieveTransactionRequest
RetrieveTransactionRequest holds the get transaction request information.
Field | Type | Label | Description |
---|---|---|---|
transaction_id | string | transaction_id is the transaction id. |
RetrieveTransactionResponse
RetrieveTransactionResponse holds the get transaction response information.
Field | Type | Label | Description |
---|---|---|---|
transaction | Transaction |
RetrieveTransactionsRequest
RetrieveTransactionsRequest holds the get transaction request information.
Field | Type | Label | Description |
---|---|---|---|
ids | RetrieveTransactionRequest | 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. |
RetrieveTransactionsResponse
RetrieveTransactionsResponse 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 |
Status
Status is the poll chat status enum type.
Name | Description |
---|---|
NONE | |
WAITING | |
READY | |
ERROR |