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.

RetrieveAccountResponse

RetrieveAccountResponse holds the get account response information.

RetrieveAccounts

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

GET /v2/account

RetrieveAccountsResponse

UpdateAccount

UpdateAccount changes the nick of an account.

PUT /v2/account/{account_id}

UpdateAccountRequest

UpdateAccountRequest holds the update account request information

UpdateAccountResponse

UpdateAccountResponse holds the update account response information

MetaService

MetaService provides metadata method for the Brankas API.

Metadata

Metadata returns the system metadata.

GET /v2/meta

MetaResponse

MetaResponse is the metadata response.

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" }

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.

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.

Login

Login validates user account authorization.

POST /v2/login

LoginRequest

LoginRequest contains the login credentials.

LoginResponse

LoginResponse contains the JWT token.

RevokeToken

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

POST /v2/revoke

RevokeRequest

RevokeRequet contains the revoke JWT request details.

ValidateToken

ValidateToken validates a given JWT token.

POST /v2/validate

ValidateRequest

ValidateRequest contains the JWT token to be validated.

ValidateResponse

ValidateResponse contains the validated JWT details.

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.

CreateCredentialResponse

CreateCredentialResponse holds the create bank credential response information.

DeleteCredential

DeleteCredential deletes a bank credential.

DELETE /v2/bankcredential/{credential_id}

DeleteCredentialRequest

DeleteCredentialRequest holds the delete bank credential request information.

DeleteCredentialResponse

DeleteCredentialResponse holds the delete bank credential response information.

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

CreateBankCredentialResponse

CreateBankCredentialResponse returns whether the bank credential was created successfully or not

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

CreateDisbursementsResponse

CreateDisbursementsResponse returns the result of a disbursements transaction

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

DeleteBankCredentialResponse

DeleteBankCredentialResponse returns whether the bank credential was deleted

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

ProcessFutureDisbursementsResponse

ProcessFutureDisbursementResponse will return the results of processing stored disbursements

RetrieveBankCredentials

RetrieveBankCredentials will return all the bank credentials for a client

GET /v2/bankcredential

RetrieveBankCredentialsResponse

RetrieveBankCredentialsResponse returns all the bank credentials 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

RetrieveDisbursementsResponse

RetrieveDisbursementsResponse returns a list of disbursements that fall inside the 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

UpdateBankCredentialResponse

UpdateBankCredentialResponse returns whether the bank credential were updated

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.

CancelMatchResponse

CancelMatchResponse holds the cancel match response information.

CreateMatch

CreateMatch initiates a payment match.

POST /v2/match

CreateMatchRequest

CreateMatchRequest holds the create match request information.

CreateMatchResponse

CreateMatchResponse holde the create match response information.

RetrieveMatch

RetrieveMatch retrieves the match data.

GET /v2/match/{match_id}

RetrieveMatchRequest

RetrieveMatchRequest holds the get match request information.

RetrieveMatchResponse

RetrieveMatchResponse holds the get match response 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.

RetrieveMatchesResponse

RetrieveMatchesResponse holds the list of get matches response information.

UpdateMatch

UpdateMatch updates the match data.

PUT /v2/match/{match_id}

UpdateMatchRequest

UpdateMatchRequest holds the update match request information.

UpdateMatchResponse

UpdateMatchResponse holde the update match response information.

OrgService

OrgService provides organization management.

CreateOrg

CreateOrg registers a new organization.

POST /v2/org

CreateOrgRequest

CreateOrgRequest holds the information to register an organization.

CreateOrgResponse

CreateOrgResponse holds the response from registering an organization.

RetrieveOrg

RetrieveOrg fetches the organization information.

GET /v2/org/{org_id}

RetrieveOrgRequest

RetrieveOrgRequest holds the get org request search parameters.

RetrieveOrgResponse

RetrieveOrgResponse holds the org information.

UpdateOrg

UpdateOrg updates organization data.

PUT /v2/org/{org_id}

UpdateOrgRequest

UpdateOrgRequest holds the update organization information.

UpdateOrgResponse

UpdateOrgResponse holds the update organization information.

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.

CreateUserResponse

CreateUserResponse holds the response from registering an organization user.

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.

RetrieveUserResponse

RetrieveUserResponse holds the matching organization users.

UpdateUser

UpdateUser updates orgUser data.

PUT /v2/orguser/{user_id}

UpdateUserRequest

UpdateUserRequest holds the information to update an existing organization user.

UpdateUserResponse

UpdateUserResponse holds the response from updating an organization user.

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

CreateServiceTokenResponse

CreateServiceTokenResponse holds the response from creating a service token.

DeleteServiceToken

DeleteServiceToken deletes a service token.

DELETE /v2/servicetoken/{token_id}

DeleteServiceTokenRequest

DeleteServiceTokenRequest holds a request to delete a service token.

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.

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

RetrieveStatementsResponse

RetrieveStatementRespones hold the get statement response information.

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.

SendTFAResponse

SendTFAResponse holds the two-factor authentication response.

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.

AdvanceTransactionResponse

AdvanceTransactionResponse holds the advance transaction response information.

CreateTransaction

CreateTransaction initiates a transaction.

POST /v2/transaction

CreateTransactionRequest

CreateTransactionRequest holds the create transaction request information.

CreateTransactionResponse

CreateTransactionResponse holds the create transaction response information.

DeleteTransaction

DeleteTransaction cancels an initiated transaction.

DELETE /v2/transaction/{transaction_id}

DeleteTransactionRequest

DeleteTransactionRequest holds the delete transaction request information.

DeleteTransactionResponse

DeleteTransactionResponse holds the delete transaction request information.

PollTransaction

PollTransaction retrieves the state of an initiated transaction.

GET /v2/transaction/{transaction_id}/poll

PollTransactionRequest

PollTransactionRequest holds the poll transaction request information.

PollTransactionResponse

PollResponse holds the poll chat response information.

RetrieveTransaction

RetrieveTransaction retrieves transaction information.

GET /v2/transaction/{transaction_id}

RetrieveTransactionRequest

RetrieveTransactionRequest holds the get transaction request information.

RetrieveTransactionResponse

RetrieveTransactionResponse holds the get transaction response information.

RetrieveTransactions

RetrieveTransactions retrieves a set of transactions.

GET /v2/transaction

RetrieveTransactionsRequest

RetrieveTransactionsRequest holds the get transaction request information.

RetrieveTransactionsResponse

RetrieveTransactionsResponse holds the get transaction response information.

Datatypes

Package Namespace brankas.v2.account

RetrieveAccountRequest

RetrieveAccountRequest holds the get account request information.

RetrieveAccountResponse

RetrieveAccountResponse holds the get account response information.

RetrieveAccountsResponse

UpdateAccountRequest

UpdateAccountRequest holds the update account request information

UpdateAccountResponse

UpdateAccountResponse holds the update account response information

Package Namespace brankas.v2.api

Account

Account contains information for a single bank account.

AccountDesc

AccountDesc holds information pertaining to an account.

Amount

Amount is a currency and number corresponding to an amount.

Bank

Bank is a banking institution record.

BankInfo

BankInfo contains information about a bank.

BankStatus

CheckStatusResponse

CheckStatusResponse contains information about the underlying system status.

CoordinateInfo

CoordinateInfo contains info pertaining to a GPS coordinate.

Country

Country is an country record.

Credential

Credential contains confidential access credential information.

Currency

Currency is a curency record.

EchoMessage

EchoMessage is an echo message.

FieldInfo

FieldInfo contains information pertaining to a form field.

ErrorTextEntry

HelpTextEntry

OptionsEntry

Filter

Filter contains the filter information for a single field.

FilterField

FilterField contains the filtering information for a single field.

FilterSet

FilterSet contains a set of filters to be applied together.

FormInfo

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

ErrorTextEntry

HelpTextEntry

Match

PossibleMatchesEntry

MetaResponse

MetaResponse is the metadata response.

OrgProfile

OrgProfile is the organization profile information.

OrgSettings

OrgSettings is the organization cutomization settings.

Profile

Profile is the user’s profile information.

ResourceInfo

ResourceInfo contains general web resource information.

Statement

Statement contains the summary of the financial transactions which have occurred over a given period on a bank account.

Transaction

Transaction contains information for a specific transaction.

TransactionMatch

FieldsEntry

Type

Type is the account type enum.

Type

Type is the account info type enum.

BankCode

BankCode is the bank code enum type.

OkStatus

OkStatus is a the generic OK status enum.

Type

Type is the credential type enum.

Type

Type is the field type enum.

Type

Type is the form type enum type.

MatchStatus

MatchStatus is the match status enum type.

Type

Type is the resource type enum.

Status

Status is an enum type defining whether an operation succeeded.

Type

Package Namespace brankas.v2.auth

ConfirmationCodeRequest

ConfirmationCodeRequest contains the confirmation code reqest.

LoginRequest

LoginRequest contains the login credentials.

LoginResponse

LoginResponse contains the JWT token.

ResourcesEntry

RevokeRequest

RevokeRequet contains the revoke JWT request details.

ValidateRequest

ValidateRequest contains the JWT token to be validated.

ValidateResponse

ValidateResponse contains the validated JWT details.

Package Namespace brankas.v2.bank

CreateCredentialRequest

CreateCredentialRequest holds the create bank credential request information.

CreateCredentialResponse

CreateCredentialResponse holds the create bank credential response information.

DeleteCredentialRequest

DeleteCredentialRequest holds the delete bank credential request information.

DeleteCredentialResponse

DeleteCredentialResponse holds the delete bank credential response information.

Package Namespace brankas.v2.disbursement

BankAccountInfo

BankAccountInfo contains information relating to a 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.

CreateBankCredentialRequest

CreateBankCredentialRequest is used to create a partial credential for a client on a bank

CreateBankCredentialResponse

CreateBankCredentialResponse returns whether the bank credential was created successfully or not

CreateDisbursementsRequest

CreateDisbursementsRequest will initiate disbursement payments to merchants clients

CredentialsEntry

CreateDisbursementsResponse

CreateDisbursementsResponse returns the result of a disbursements transaction

Date

Date indicates a specific date

DeleteBankCredentialRequest

DeleteBankCredentialRequest will delete a partial credential for a client on a bank

DeleteBankCredentialResponse

DeleteBankCredentialResponse returns whether the bank credential was deleted

Disbursement

Disbursement contains data for a disbursement

DisbursementResult

DisbursementResult is a disbursement plus it’s response from the bank, the disbursement was created with

ProcessFutureDisbursementsRequest

ProcessFutureDisbursementsRequest will start processing stored disbursements

CredentialsEntry

ProcessFutureDisbursementsResponse

ProcessFutureDisbursementResponse will return the results of processing stored disbursements

Result

Result is a response result with whether the response is a success or what the error was

RetrieveBankCredentialsResponse

RetrieveBankCredentialsResponse returns all the bank credentials 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

RetrieveDisbursementsResponse

RetrieveDisbursementsResponse returns a list of disbursements that fall inside the date range

UpdateBankCredentialRequest

UpdateBankCredentialRequest is used to update a partial credential for a client on a bank

UpdateBankCredentialResponse

UpdateBankCredentialResponse returns whether the bank credential were updated

BankAccountType

BankAccountType indicates which account to use

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

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 ‘’.

Type

Status

Status that a disbursement transaction could be in

Package Namespace brankas.v2.match

CancelMatchRequest

CancelMatchRequest holds the cancel match request information.

CancelMatchResponse

CancelMatchResponse holds the cancel match response information.

CreateMatchRequest

CreateMatchRequest holds the create match request information.

CreateMatchResponse

CreateMatchResponse holde the create match response information.

RetrieveMatchRequest

RetrieveMatchRequest holds the get match request information.

RetrieveMatchResponse

RetrieveMatchResponse holds the get match response information.

RetrieveMatchesRequest

RetrieveMatchesRequest holds the list of get matches request information.

RetrieveMatchesResponse

RetrieveMatchesResponse holds the list of get matches response information.

UpdateMatchRequest

UpdateMatchRequest holds the update match request information.

UpdateMatchResponse

UpdateMatchResponse holde the update match response information.

Package Namespace brankas.v2.org

CreateOrgRequest

CreateOrgRequest holds the information to register an organization.

CreateOrgResponse

CreateOrgResponse holds the response from registering an organization.

CreateUserRequest

CreateUserRequest holds the information to register an organization user.

CreateUserResponse

CreateUserResponse holds the response from registering an organization user.

RetrieveOrgRequest

RetrieveOrgRequest holds the get org request search parameters.

RetrieveOrgResponse

RetrieveOrgResponse holds the org information.

RetrieveUserRequest

RetrieveUserRequest holds the parameters to retrieve an organization user.

RetrieveUserResponse

RetrieveUserResponse holds the matching organization users.

UpdateOrgRequest

UpdateOrgRequest holds the update organization information.

UpdateOrgResponse

UpdateOrgResponse holds the update organization information.

UpdateUserRequest

UpdateUserRequest holds the information to update an existing organization user.

UpdateUserResponse

UpdateUserResponse holds the response from updating an organization user.

OrgStatus

OrgStatus is the organization status enum.

ProfileStatus

ProfileStatus is the profile status enum.

Package Namespace brankas.v2.servicetoken

CreateServiceTokenRequest

CreateServiceTokenRequest holds the service token creation information

CreateServiceTokenResponse

CreateServiceTokenResponse holds the response from creating a service token.

DeleteServiceTokenRequest

DeleteServiceTokenRequest holds a request to delete a service token.

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.

TokenMetadata

TokenMetadata holds the metadata associated with a service token.

Package Namespace brankas.v2.statement

RetrieveStatementsRequest

RetrieveStatementRequest holds the get request information

RetrieveStatementsResponse

RetrieveStatementRespones hold the get statement response information.

StatementsList

StatementsList holds the statements fetched from the bank.

Sent to the organization’s registered webhook .

StatementStatus

StatementStatus is the status of a statment request.

Package Namespace brankas.v2.tfa

SendTFARequest

SendTFARequest holds the two-factor authentication request.

SendTFAResponse

SendTFAResponse holds the two-factor authentication response.

Status

TFAPurpose

Package Namespace brankas.v2.transaction

AdvanceTransactionRequest

AdvanceTransactionRequest holds the advance transaction request information.

AdvanceTransactionResponse

AdvanceTransactionResponse holds the advance transaction response information.

CreateTransactionRequest

CreateTransactionRequest holds the create transaction request information.

CreateTransactionResponse

CreateTransactionResponse holds the create transaction response information.

DeleteTransactionRequest

DeleteTransactionRequest holds the delete transaction request information.

DeleteTransactionResponse

DeleteTransactionResponse holds the delete transaction request information.

PollTransactionRequest

PollTransactionRequest holds the poll transaction request information.

PollTransactionResponse

PollResponse holds the poll chat response information.

RetrieveTransactionRequest

RetrieveTransactionRequest holds the get transaction request information.

RetrieveTransactionResponse

RetrieveTransactionResponse holds the get transaction response information.

RetrieveTransactionsRequest

RetrieveTransactionsRequest holds the get transaction request information.

RetrieveTransactionsResponse

RetrieveTransactionsResponse holds the get transaction response information.

Status

Status is the poll chat status enum type.