Brankas Direct API v1.0.0
Brankas Direct provides Fintechs and SME with an API-driven payment solution that allows to digitally transact with customers and their end-users. By debiting the customers' online bank accounts and transferring directly to the fintech’s or SME’s payable accounts, Brankas Direct leverages on enterprises that are able to execute fund transfer-based transactions over a growing basket of banks via a single set of APIs.
Checkout
The Checkout endpoint creates a fund transfer initiation request that the end user can complete via the Brankas Identity Provider service (IdP). The Checkout endpoint is a fund transfer initiation request specific to the use case where the transaction amount is a predetermined value not defined by the end user, usually determined by an invoice or cart. Direct will create a unique user session on the Brankas IDP keyed to the fund transfer request’s internal transfer_id. The Checkout endpoint will respond with a preformatted URL that the end user must be redirected to in order to authorize the current fund transfer request. The Brankas Client needs to append the returned preformatted URL with their own redirect_uri query parameter where the end user will be sent after they have completed their session on the IDP.
curl -X POST \
https://docs.brank.as/v1/checkout \
-H 'Authorization: Bearer USE_YOUR_TOKEN' \
-d '{
"customer": {
"fname": "string",
"lname": "string",
"mname": "string",
"email": "string",
"mobile": "string",
"phone": "string",
"customer_id": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"province": "string",
"zip_code": "string",
"country": "string"
}
},
"reference_id": "string",
"amount": {
"cur": "CurrencyISO4217",
"num": "string"
},
"from": {
"type": "AccountInfoType",
"bank_code": "BankCode",
"account_number": "string",
"identifier": "string",
"holder_name": "string",
"country": "CountryISO3166"
},
"payment_channel": "PaymentChannelType",
"memo": "string",
"destination_account_id": "string",
"client": {
"display_name": "string",
"logo_url": "string",
"return_url": "string",
"fail_url": "string",
"encrypted_creds": "string",
"deep_link": "bool",
"header_text": "string"
}
}'
HTTP Request
POST https://docs.brank.as/v1/checkout
Body Parameters
| Name | Type | Description |
|---|
| customer | Customer | customer is the end user’s identifying and contact information that allows transactions to be attributed to a specific end user. This can be used by both banks and settlement channels to assist in the resolution of transaction disputes. |
| reference_id | string | reference_id is an additional identifier, such as a UUID, that corresponds to an invoice, cart, or transaction object. The Brankas Client can use this field to associate the fund transfer request to a corresponding transaction object in its transaction database. |
| amount | Amount | amount is the transaction amount to be transferred from the source account to the destination account. If minor currency units are supported by a currency, then they are stored as minor units. For example, PHP 100.00 would be represented as “amount.num”: “10000”. Note that amounts are stored as string instead of integers in order to prevent any errors caused by floating point numbers. |
| from | AccountInfo | from is the source account information. Make sure the bank code on this field is set, this bank will be used to initiate the transfer. Bank Codes used in this field follow a different convention from the bank codes used for the destination account in the to object. For the full list of supported bank codes, see Source Account Bank Codes in the Bank Codes section. |
| payment_channel | PaymentChannelType | payment_channel is to be used for inter-bank fund transfers. Allows for the selection of established payment networks, clearing houses, or settlement partners to be used in order to facilitate an inter-bank fund transfer. This field is only required if the fund transfer is an inter-bank fund transfer. Otherwise, if the fund transfer is an intra-bank transfer, this field should be completely omitted. |
| memo | string | memo is a user defined remarks attached to the transfer in the memo line (e.g. RRN). |
| destination_account_id | string | destination_account_id is the string ID corresponding to the bank information of the recipient. |
| client | Client | client contains the relevant information about the client who uses the checkout flow. |
Objects
Customer
| Name | Type | Description |
|---|
| fname | string | The end user’s first name. |
| lname | string | The end user’s last name. |
| mname | string | The end user’s middle name. |
| email | string | The customer’s contact email. |
| mobile | string | The end user’s mobile phone number. |
| phone | string | Phone is the customer’s Landline number. |
| customer_id | string | An additional user identifier, such as a UUID, that the Brankas client can optionally add to the customer object. |
| address | Address | Address is the customer’s address. |
InvoiceDetails
| Name | Type | Description |
|---|
| line_items | []LineItem | LineItems is the list of ordered item details |
| charges | []Charge | Charges is the list of cost/charge corresponding to each item in LineItems |
| discount | []Discount | Discounts is the list of discounts corresponding to each item in LineItems |
| amount | Amount | Amount is the overall cost of all orders |
Amount
| Name | Type | Description |
|---|
| cur | CurrencyISO4217 | Cur is the currency. |
| num | string | Num is the numeric value. |
AccountInfo
| Name | Type | Description |
|---|
| type | AccountInfoType | The type of info relating to a bank transfer account. |
| bank_code | BankCode | Brankas bank code. Only present when type is BANK. Bank Codes differ depending on whether they are used as the source or the destination of a funds transfer. For the full list and details on bank codes, please see the Bank Codes section. |
| account_number | string | AccountNumber is a bank account number. |
| identifier | string | A unique account Id, profile Id or the bank account number depending on the type. |
| holder_name | string | The name of the account holder. |
| country | CountryISO3166 | The country where the end user’s bank is based using ISO 3166 Alpha-2 country codes. Currently supports: Indonesia: ID, Philippines: PH, & Thailand: TH. |
DestinationAccountInfo
| Name | Type | Description |
|---|
| type | AccountInfoType | Type is the account info type. |
| bank_code | DestinationBankCode | BankCode is a bank code. Only present when type is BANK. |
| account_number | string | AccountNumber is a bank account number. |
| identifier | string | Identifier is a unique account ID, profile ID, or the bank account number and is interpreted based on the account info type. |
| holder_name | string | HolderName is the name of the account holder. This field is DEPRECATED in favor of the HolderFirstName, HolderMiddleName and HolderLastName which we join to come up with a full name. |
| holder_first_name | string | HolderFirstName is the first name of the account holder. |
| holder_middle_name | string | HolderMiddleName is the middle name of the account holder. |
| holder_last_name | string | HolderLastName is the last name of the account holder. |
| email_address | string | EmailAddress is the destination user email address. |
| mobile_country_code | string | MobileCountryCode is the mobile country dial code. |
| mobile_number | string | MobileNumber is the destination user mobile number. |
| address_line1 | string | AddressLine1 is the user destination address information. |
| address_line2 | string | AddressLine1 is the user destination address additional information. |
| city | string | City is the user destination residential city. |
| state | string | State is the user destination residential state. |
| country | string | Country is the user destination residential country. |
Client
| Name | Type | Description |
|---|
| display_name | string | DisplayName of the client |
| logo_url | string | LogoURL is the link to the client’s logo |
| return_url | string | ReturnURL is the return path via a redirect after a checkout transaction has been accomplished |
| fail_url | string | FailURL is the return path via a redirect after a checkout transaction has failed |
| encrypted_creds | string | EncryptedCredential is the encrypted user credentials used to enable the user to skip the log in process |
| deep_link | bool | DeepLink indicates that the client wanted to display remember me feature on login form |
| header_text | string | HeaderText is the text for the header replacing the logo |
Address
| Name | Type | Description |
|---|
| line1 | string | Line1 is the customer’s first line of address |
| line2 | string | Line2 is the customer’s second line of address |
| city | string | City is the customer’s city |
| province | string | Province is the customer’s province |
| zip_code | string | ZipCode is the customer’s postal code |
| country | string | Country is the country the customer is located in |
LineItem
| Name | Type | Description |
|---|
| item_name | string | ItemName is name of the item |
| item_id | string | ItemID is any internal ID the Brankas Client/merchant might have to represent this item |
| unit_price | string | UnitPrice is the price of a single unit of the item |
| price_cur | CurrencyISO4217 | PriceCur is the currency for the lineitem price following ISO_4217 |
| quantity | int32 | Quantity is the number of items |
Charge
| Name | Type | Description |
|---|
| charge_type | string | ChargeType is the type of charge for the corresponding lineitem |
| charge_amount | string | ChargeAmount is the amount cost for the corresponding lineitem |
| charge_cur | CurrencyISO4217 | DiscountCur is the currency for the charge following ISO_4217 |
Discount
| Name | Type | Description |
|---|
| discount_type | string | DiscountType is the type of discount for the correspondign lineitem |
| discount_amount | string | DiscountAmount is the amount discounted for the corresponding lineitem |
| discount_cur | CurrencyISO4217 | DiscountCur is the currency for the discount following ISO_4217 |
Enums
PaymentChannelType
PaymentChannelType is the payment rail that will be used to facilitate the inter-bank fund transfer. Allows for the selection of established payment networks, switching service, clearing houses, or settlement partners to be used in order to move fund transfer to the beneficiary bank and bank account.
| Value | Description |
|---|
| ID_LLG | |
| ID_RTGS | |
| PH_PESONET | Process inter-bank fund transfer via the PESONet electronic fund transfer (EFT) Automated Clearing House. |
| PH_INSTAPAY | Process inter-bank fund transfer via the InstaPay electronic fund transfer (EFT) Automated Clearing House. |
| PH_PAYNAMICS | Process inter-bank fund transfer via Paynamics settlements service, a Brankas Partner. |
| ID_BANK_MEGA_IPG | Process inter-bank fund transfer via Bank Mega - IPG settlements service. |
CurrencyISO4217
CurrencyISO4217 iso is the 3 digit currency that will be used as standard currency type on fast checkout. see: https://en.wikipedia.org/wiki/ISO_4217
| Value | Description |
|---|
| UNKNOWN_CURRENCY | |
| AFN | |
| EUR | |
| ALL | |
| DZD | |
| USD | |
| AOA | |
| XCD | |
| ARS | |
| AMD | |
| AWG | |
| AUD | |
| AZN | |
| BSD | |
| BHD | |
| BDT | |
| BYR | |
| BZD | |
| XOF | |
| BMD | |
| BTN | |
| BOV | |
| BAM | |
| BWP | |
| NOK | |
| BRL | |
| SGD | |
| BGN | |
| BIF | |
| KHR | |
| XAF | |
| CAD | |
| CVE | |
| KYD | |
| CLP | |
| CNY | |
| COP | |
| KMF | |
| CDF | |
| NZD | |
| CRC | |
| HRK | |
| CUC | |
| CZK | |
| DKK | |
| DJF | |
| DOP | |
| EGP | |
| ERN | |
| ETB | |
| FKP | |
| FJD | |
| XPF | |
| GMD | |
| GEL | |
| GHS | |
| GIP | |
| GTQ | |
| GBP | |
| GNF | |
| GYD | |
| HNL | |
| HKD | |
| HUF | |
| ISK | |
| INR | |
| IDR | |
| IRR | |
| IQD | |
| IMP | |
| ILS | |
| JMD | |
| JPY | |
| JEP | |
| JOD | |
| KZT | |
| KES | |
| KPW | |
| KRW | |
| KWD | |
| KGS | |
| LAK | |
| LBP | |
| LSL | |
| LRD | |
| LYD | |
| CHF | |
| MKD | |
| MGA | |
| MWK | |
| MYR | |
| MVR | |
| MRO | |
| MUR | |
| MXN | |
| MDL | |
| MNT | |
| MAD | |
| MZN | |
| MMK | |
| NAD | |
| NPR | |
| ANG | |
| NIO | |
| NGN | |
| OMR | |
| PKR | |
| PGK | |
| PYG | |
| PEN | |
| PHP | |
| PLN | |
| QAR | |
| RON | |
| RUB | |
| RWF | |
| WST | |
| STD | |
| SAR | |
| RSD | |
| SCR | |
| SLL | |
| SBD | |
| SOS | |
| ZAR | |
| SSP | |
| LKR | |
| SHP | |
| SDG | |
| SRD | |
| SZL | |
| SEK | |
| SYP | |
| TWD | |
| TJS | |
| TZS | |
| THB | |
| TOP | |
| TTD | |
| TND | |
| TRY | |
| TMT | |
| UGX | |
| UAH | |
| ARE | |
| UYU | |
| UZS | |
| VUV | |
| VEF | |
| VND | |
| YER | |
| ZRN | |
| ZMW | |
AccountInfoType
AccountInfoType is the type of info relating to a bank transfer account.
| Value | Description |
|---|
| AccountInfoTypeUNKNOWN | Unrecognised info type. |
| ACCOUNT | Account type. |
| PROFILE | Profile type. |
| BANK | Bank type. |
| MSISDN | Phone number type. |
BankCode
| Value | Description |
|---|
| UNKNOWN_BANK | |
| MANDIRI_PERSONAL | PT. Bank Mandiri (Persero), TBK. |
| BCA_PERSONAL | PT. Bank Central Asia, TBK. |
| BNI_PERSONAL | PT. Bank Negara Indonesia (Persero), TBK. |
| BRI_PERSONAL | PT. Bank Rakyat Indonesia (Persero), TBK. |
| BCA_CORPORATE | |
| DUMMY_BANK_PERSONAL | Brankas Bank. A test bank that you can make sandboxed calls to as part of integration testing. |
| BDO_PERSONAL | Banco De Oro Unibank, Inc. (BDO). |
| BPI_PERSONAL | Bank of the Philippine Islands (BPI). |
| PNB_PERSONAL | Philippine National Bank (PNB). |
| UNIONBANK_PERSONAL | |
| UNIONBANK_CORPORATE | |
| METROBANK_PERSONAL | The Metropolitan Bank and Trust Company (Metrobank). |
| RCBC_PERSONAL | The Rizal Commercial Banking Corporation (RCBC). |
| CLRB_PERSONAL | Cebuana Lhuillier Rural Bank (CLRB). |
| DUMMY_BANK_BCA_PERSONAL | BCA dummy bank that can make sandboxed calls as part of integration testing. (DEPRECATED) |
| KOMO_PERSONAL | Komo / EastWest Rural Ban |
| SCB_PERSONAL | TH |
| KASIKORNBANK_PERSONAL | |
CountryISO3166
| Value | Description |
|---|
| Unknown | |
| ID | |
| PH | |
| TH | |
DestinationBankCode
| Value | Description |
|---|
| UNKNOWN_DESTINATION_BANK | |
| DUMMY_BANK_DESTINATION | |
| ID_BCA | |
| ID_BCA_SYR | |
| ID_BNI | |
| ID_BNI_SYR | |
| ID_BRI | |
| ID_BRI_SYR | |
| ID_MANDIRI | |
| ID_MANDIRI_SYR | |
| ID_BTN | |
| ID_BTN_SYR | |
| ID_PERMATA | |
| ID_PERMATA_SYR | |
| ID_DNMN | |
| ID_DNMN_SYR | |
| ID_BTPN | |
| ID_BTPN_SYR | |
| ID_OCBC | |
| ID_OCBC_SYR | |
| ID_MAYBANK | |
| ID_MAYBANK_SYR | |
| ID_CIMB | |
| ID_CIMB_SYR | |
| ID_PAN | |
| ID_PAN_SYR | |
| ID_MEGA | |
| ID_MEGA_SYR | |
| ID_BKP | |
| ID_BKP_SYR | |
| ID_DKI | |
| ID_DKI_SYR | |
| ID_BJB | |
| ID_BJB_SYR | |
| ID_JATIM | |
| ID_JATIM_SYR | |
| ID_HSBC | |
| ID_DBS | |
| ID_STAN | |
| ID_UOB | |
| ID_CITI | |
| PH_BDO | |
| PH_BPI | |
| PH_BPIF | |
| PH_METRO | |
| PH_PNB | |
| PH_PNBS | |
| PH_RCBC | |
| PH_RCBCS | |
| PH_SB | |
| PH_SBS | |
| PH_UB | |
| PH_CLRB | |
| PH_GXI | |
| PH_GBY | |
| PH_LBP | |
| PH_PMP | |
| PH_PSB | |
| PH_RSB | |
| PH_CB | |
| PH_CBS | |
| TH_KBANK | |
| DUMMY_INTERBANK_DESTINATION | |
| PH_ALLBANK | |
| PH_SUNSB | |
| PH_STERLING | |
| PH_MBSMB | |
| PH_AUB | |
| PH_BOC | |
| PH_MAYBANK | |
| PH_PBCOM | |
| PH_CTBC | |
| PH_EWB | |
| PH_EQB | |
| PH_OMNIPAY | |
| PH_UCPB | |
| PH_PHILTRUST | |
| PH_WDB | |
| PH_DUNGGANUN | |
| PH_UCPBSB | |
| PH_ISLA | |
| PH_PRBC | |
| PH_PBB | |
| PH_PVB | |
| PH_YSBP | |
| PH_MABUHAY | |
| PH_CTBCPH | |
| PH_ING | |
| PH_QCRB | |
| PH_BDONB | |
| PH_EWBRB | |
| TH_SCB | |
| PH_STAN | |
| PH_HSBC | |
| PH_CITI | |
| PH_BOA | |
| PH_UOB | |
| PH_TOKYO | |
| PH_MICB | |
| PH_DBP | |
| PH_ANZ | |
| PH_KEB_HANA | |
| PH_CHASE | |
| PH_FCB | |
| PH_MIZUHO | |
| PH_DBS | |
| PH_BBL | |
| PH_CHINA | |
| PH_SUMITOMO_MITSUI | |
| PH_SHINHAN | |
| PH_IBK | |
| PH_STARPAY | |
| PH_QUEENBANK | |
| PH_INNOVATIVE_BANK | |
| PH_AAIIB | |
| PH_PRODUCERSSBC | |
| PH_BPI_BANKO | |
| PH_CIMB | |
| PH_BANKFLORIDAPH | |
| PH_GUINOBATAN | |
| PH_HSBCSB | |
| PH_CAMALIG | |
| PH_COUNTRY_BUILDERS | |
| PH_RANGAY_BANK | |
| PH_COINSPH | |
| PH_CARDBANK | |
Responses
Response body
| Name | Type | Description |
|---|
| transaction_id | string | transaction_id is the unique identifier assigned to the fund transfer request. |
| redirect_uri | string | redirect_uri is the URL that end users need to be redirected to in order to authorize the fund transfer and complete the transaction. |
| bank_interaction_methods | []BankInteractionMethod | bank_interaction_methods are the available methods to interact with the bank. |
Enums
BankInteractionMethod
BankInteractionMethod are the possible methods to interact with a bank.
| Value | Description |
|---|
| UNKNOWN_INTERACTION_METHOD | Unknown bank interaction method. |
| SCRAPER | Scraper is a bank interaction method, which scrapes actual web pages. |
| API | API is a bank interaction method, which uses endpoints to interact with banks and handles account selection phase on bank side. |
| QRCODE | QRCode uses the qrcode generated by the bank itself to fulfill the fund transfer. |
| APIWithAccountSelection | API With Account Selection is a bank interaction method, which uses API to interact but handles the account selection phase on brankas side. |
Example:
{
"transaction_id": "string",
"redirect_uri": "string",
"bank_interaction_methods": "[]BankInteractionMethod"
}
Response codes
| Status | Description |
|---|
| 200 | Request executed successfully. |
| 404 | Returned when the resource is not found. |
| 400 | Returned when the request body is malformatted or does not match the expected request. |
| 401 | Returned when the request does not contains the user’s credentials. |
| 403 | Returned when the user does not have permission to access the resource. |
| 500 | Returned when an unexpected error occured on the server side. |
Retrieve the transfers
RetrieveTransfer returns the details of a fund transfer request. By specifying the transfer_id of the relevant transaction as a query parameter, only the record specific to that transfer will be retrieved. If no transfer_id is specified in the query parameter, the response will return all transaction records and list them from most recent to latest. Retrieved transaction records are paginated.
curl -X GET \
https://docs.brank.as/v1/transfer \
-H 'Authorization: Bearer USE_YOUR_TOKEN'
HTTP Request
GET https://docs.brank.as/v1/transfer
Responses
Response body
| Name | Type | Description |
|---|
| transfers | []Transfer | transfers are the transfers that match the filters of a request. |
| next_page | int32 | next_page is the number of the next page that can be returned. if it is 0, there are no more pages available. |
Objects
Transfer
| Name | Type | Description |
|---|
| status | Status | status indicates the current status of the transfer. |
| from | AccountInfo | from is the source account information. Make sure the bank code on this field is set, this bank will be used to initiate the transfer. |
| to | DestinationAccountInfo | to is the destination account information. |
| amount | Amount | amount is the transaction amount to be transferred from the source account to the destination account. |
| user_memo | string | user_memo is a user defined remarks attached to the transfer in the memo line (e.g. RRN). |
| bank_memo | string | bank_memo is a bank-supplied memo line (e.g. confirmation number, payment reference code, or transaction ID of the fund transfer). |
| created | Timestamp | created is a timestamp when the transfer transaction was initiated. |
| completed | Timestamp | completed is a timestamp when the transfer transaction was fully processed. |
| payment_channel | string | payment channel is the desired payment channel to be used for inter-bank fund transfers. Allows for the selection of established payment networks, clearing houses, or settlement partners to be used in order to facilitate an inter-bank fund transfer. |
| settlement | Settlement | settlement displays initial confirmation details for inter-bank fund transfer transactions from settlement partners and clearing services, indicating that the fund transfer has been received by the service and that the settlement will be carried out. |
| customer | Customer | customer is the end user’s identifying and contact information that allows transactions to be attributed to a specific end user. |
| transfer_id | string | transfer_id is the internal transfer transaction identifier. |
| updated | Timestamp | updated is the timestamp when the transfer was modified. |
| reference_id | string | reference_id is the client identifier for an invoice object. |
| bank_ref_code | string | bank_ref_code is the code assigned by bank to track the transaction. |
| org_id | string | org_id is the unique organization identifier. |
| consent_granted | bool | consent_granted is the flag that represents if the user gave the system its consent. |
| additional_details | AdditionalDetails | additional_details contains the additional optional information related to the transaction. |
| bank_interaction_method | BankInteractionMethod | bank_interaction_method is the selected method to interact with the bank. |
AccountInfo
| Name | Type | Description |
|---|
| type | AccountInfoType | The type of info relating to a bank transfer account. |
| bank_code | BankCode | Brankas bank code. Only present when type is BANK. Bank Codes differ depending on whether they are used as the source or the destination of a funds transfer. For the full list and details on bank codes, please see the Bank Codes section. |
| account_number | string | AccountNumber is a bank account number. |
| identifier | string | A unique account Id, profile Id or the bank account number depending on the type. |
| holder_name | string | The name of the account holder. |
| country | CountryISO3166 | The country where the end user’s bank is based using ISO 3166 Alpha-2 country codes. Currently supports: Indonesia: ID, Philippines: PH, & Thailand: TH. |
DestinationAccountInfo
| Name | Type | Description |
|---|
| type | AccountInfoType | Type is the account info type. |
| bank_code | DestinationBankCode | BankCode is a bank code. Only present when type is BANK. |
| account_number | string | AccountNumber is a bank account number. |
| identifier | string | Identifier is a unique account ID, profile ID, or the bank account number and is interpreted based on the account info type. |
| holder_name | string | HolderName is the name of the account holder. This field is DEPRECATED in favor of the HolderFirstName, HolderMiddleName and HolderLastName which we join to come up with a full name. |
| holder_first_name | string | HolderFirstName is the first name of the account holder. |
| holder_middle_name | string | HolderMiddleName is the middle name of the account holder. |
| holder_last_name | string | HolderLastName is the last name of the account holder. |
| email_address | string | EmailAddress is the destination user email address. |
| mobile_country_code | string | MobileCountryCode is the mobile country dial code. |
| mobile_number | string | MobileNumber is the destination user mobile number. |
| address_line1 | string | AddressLine1 is the user destination address information. |
| address_line2 | string | AddressLine1 is the user destination address additional information. |
| city | string | City is the user destination residential city. |
| state | string | State is the user destination residential state. |
| country | string | Country is the user destination residential country. |
Amount
| Name | Type | Description |
|---|
| cur | CurrencyISO4217 | Cur is the currency. |
| num | string | Num is the numeric value. |
Timestamp
| Name | Type | Description |
|---|
| seconds | int64 | |
| nanos | int32 | |
Settlement
| Name | Type | Description |
|---|
| settlement_id | string | ID represents the settlement ticket/request on the settlement partner’s system. |
| settlement_response_id | string | ResponseID is the ID that a settlements partner attaches to each settlement status update POST from their systems |
| settlement_response_code | SettlementResponseCode | SettlementResponseCode is the response code sent by a settlements partner indicating the status of the settlement item. |
| settlement_response_status | string | Status the human-readable status of the response code. |
| settlement_timestamp | Timestamp | Timestamp is the ID that a settlement partner attaches to each settlement status update POST from their systems |
Customer
| Name | Type | Description |
|---|
| fname | string | The end user’s first name. |
| lname | string | The end user’s last name. |
| mname | string | The end user’s middle name. |
| email | string | The customer’s contact email. |
| mobile | string | The end user’s mobile phone number. |
| phone | string | Phone is the customer’s Landline number. |
| customer_id | string | An additional user identifier, such as a UUID, that the Brankas client can optionally add to the customer object. |
| address | Address | Address is the customer’s address. |
AdditionalDetails
| Name | Type | Description |
|---|
| qr_code | string | QRCodeRawData contains the raw text data that will be used to recreate the QRCode. |
| account_alias_id | string | AccountAliasID is the alternative identifier of the destination account. |
| to_address_line1 | string | ToAddressLine1 is the user destination address information. |
| to_address_line2 | string | ToAddressLine1 is the user destination address additional information. |
| to_city | string | ToCity is the user destination residential city. |
| to_state | string | ToState is the user destination residential state. |
| to_country | string | ToCountry is the user destination residential country. |
| terms_of_use_version | string | TermsOfUseVersion is the version number of the terms of use document that the user interacted unto. |
| privacy_policy_version | string | PrivacyPolicyVersion is the version number of the privacy policy document that the user interacted unto. |
| user_id_hash | string | UserIdHash is the hash of the end user’s bank code and online banking username used to uniquely identify an end user across clients |
| user_access_hash | string | UserAccessHash is the hash of the end user’s bank code and online banking credentials used to uniquely identify an end user based on their access credentials |
| user_account_hash | string | UserAccountHash is the hash of the end user’s bank code and specific bank account used for the transaction used to identify if the end user is using the same or different bank accounts |
| via | Via | Via indicates fund transfer rail used for the transfer |
| bank_fee | Amount | BankFee indicates the amount that will be deducted from the end user’s account as a fee from the bank for performing the fund transfer |
Address
| Name | Type | Description |
|---|
| line1 | string | Line1 is the customer’s first line of address |
| line2 | string | Line2 is the customer’s second line of address |
| city | string | City is the customer’s city |
| province | string | Province is the customer’s province |
| zip_code | string | ZipCode is the customer’s postal code |
| country | string | Country is the country the customer is located in |
Enums
Status
Status is the possible statuses of a transfer or account listing operation.
| Value | Description |
|---|
| PENDING | Pending operation. |
| AWAITING_TFA | Awaiting TFA authentication. |
| SUCCESS | Successful operation. |
| ERROR | Error during operation. |
| LOGIN_ERROR | Login Error. |
| INVOICE_CREATED | Checkout invoice created. |
| AWAITING_LOGIN | Login in progress. |
| AWAITING_LOGIN_TFA | Awaiting login TFA Authentication. |
| AWAITING_ACCOUNT_SELECT | Awaiting account selection. |
| AWAITING_TRANSFER_TFA | Awaiting transfer TFA Authentication. |
| IN_PROGRESS | Transfer is in progress. |
BankInteractionMethod
BankInteractionMethod are the possible methods to interact with a bank.
| Value | Description |
|---|
| UNKNOWN_INTERACTION_METHOD | Unknown bank interaction method. |
| SCRAPER | Scraper is a bank interaction method, which scrapes actual web pages. |
| API | API is a bank interaction method, which uses endpoints to interact with banks and handles account selection phase on bank side. |
| QRCODE | QRCode uses the qrcode generated by the bank itself to fulfill the fund transfer. |
| APIWithAccountSelection | API With Account Selection is a bank interaction method, which uses API to interact but handles the account selection phase on brankas side. |
AccountInfoType
AccountInfoType is the type of info relating to a bank transfer account.
| Value | Description |
|---|
| AccountInfoTypeUNKNOWN | Unrecognised info type. |
| ACCOUNT | Account type. |
| PROFILE | Profile type. |
| BANK | Bank type. |
| MSISDN | Phone number type. |
BankCode
| Value | Description |
|---|
| UNKNOWN_BANK | |
| MANDIRI_PERSONAL | PT. Bank Mandiri (Persero), TBK. |
| BCA_PERSONAL | PT. Bank Central Asia, TBK. |
| BNI_PERSONAL | PT. Bank Negara Indonesia (Persero), TBK. |
| BRI_PERSONAL | PT. Bank Rakyat Indonesia (Persero), TBK. |
| BCA_CORPORATE | |
| DUMMY_BANK_PERSONAL | Brankas Bank. A test bank that you can make sandboxed calls to as part of integration testing. |
| BDO_PERSONAL | Banco De Oro Unibank, Inc. (BDO). |
| BPI_PERSONAL | Bank of the Philippine Islands (BPI). |
| PNB_PERSONAL | Philippine National Bank (PNB). |
| UNIONBANK_PERSONAL | |
| UNIONBANK_CORPORATE | |
| METROBANK_PERSONAL | The Metropolitan Bank and Trust Company (Metrobank). |
| RCBC_PERSONAL | The Rizal Commercial Banking Corporation (RCBC). |
| CLRB_PERSONAL | Cebuana Lhuillier Rural Bank (CLRB). |
| DUMMY_BANK_BCA_PERSONAL | BCA dummy bank that can make sandboxed calls as part of integration testing. (DEPRECATED) |
| KOMO_PERSONAL | Komo / EastWest Rural Ban |
| SCB_PERSONAL | TH |
| KASIKORNBANK_PERSONAL | |
CountryISO3166
| Value | Description |
|---|
| Unknown | |
| ID | |
| PH | |
| TH | |
DestinationBankCode
| Value | Description |
|---|
| UNKNOWN_DESTINATION_BANK | |
| DUMMY_BANK_DESTINATION | |
| ID_BCA | |
| ID_BCA_SYR | |
| ID_BNI | |
| ID_BNI_SYR | |
| ID_BRI | |
| ID_BRI_SYR | |
| ID_MANDIRI | |
| ID_MANDIRI_SYR | |
| ID_BTN | |
| ID_BTN_SYR | |
| ID_PERMATA | |
| ID_PERMATA_SYR | |
| ID_DNMN | |
| ID_DNMN_SYR | |
| ID_BTPN | |
| ID_BTPN_SYR | |
| ID_OCBC | |
| ID_OCBC_SYR | |
| ID_MAYBANK | |
| ID_MAYBANK_SYR | |
| ID_CIMB | |
| ID_CIMB_SYR | |
| ID_PAN | |
| ID_PAN_SYR | |
| ID_MEGA | |
| ID_MEGA_SYR | |
| ID_BKP | |
| ID_BKP_SYR | |
| ID_DKI | |
| ID_DKI_SYR | |
| ID_BJB | |
| ID_BJB_SYR | |
| ID_JATIM | |
| ID_JATIM_SYR | |
| ID_HSBC | |
| ID_DBS | |
| ID_STAN | |
| ID_UOB | |
| ID_CITI | |
| PH_BDO | |
| PH_BPI | |
| PH_BPIF | |
| PH_METRO | |
| PH_PNB | |
| PH_PNBS | |
| PH_RCBC | |
| PH_RCBCS | |
| PH_SB | |
| PH_SBS | |
| PH_UB | |
| PH_CLRB | |
| PH_GXI | |
| PH_GBY | |
| PH_LBP | |
| PH_PMP | |
| PH_PSB | |
| PH_RSB | |
| PH_CB | |
| PH_CBS | |
| TH_KBANK | |
| DUMMY_INTERBANK_DESTINATION | |
| PH_ALLBANK | |
| PH_SUNSB | |
| PH_STERLING | |
| PH_MBSMB | |
| PH_AUB | |
| PH_BOC | |
| PH_MAYBANK | |
| PH_PBCOM | |
| PH_CTBC | |
| PH_EWB | |
| PH_EQB | |
| PH_OMNIPAY | |
| PH_UCPB | |
| PH_PHILTRUST | |
| PH_WDB | |
| PH_DUNGGANUN | |
| PH_UCPBSB | |
| PH_ISLA | |
| PH_PRBC | |
| PH_PBB | |
| PH_PVB | |
| PH_YSBP | |
| PH_MABUHAY | |
| PH_CTBCPH | |
| PH_ING | |
| PH_QCRB | |
| PH_BDONB | |
| PH_EWBRB | |
| TH_SCB | |
| PH_STAN | |
| PH_HSBC | |
| PH_CITI | |
| PH_BOA | |
| PH_UOB | |
| PH_TOKYO | |
| PH_MICB | |
| PH_DBP | |
| PH_ANZ | |
| PH_KEB_HANA | |
| PH_CHASE | |
| PH_FCB | |
| PH_MIZUHO | |
| PH_DBS | |
| PH_BBL | |
| PH_CHINA | |
| PH_SUMITOMO_MITSUI | |
| PH_SHINHAN | |
| PH_IBK | |
| PH_STARPAY | |
| PH_QUEENBANK | |
| PH_INNOVATIVE_BANK | |
| PH_AAIIB | |
| PH_PRODUCERSSBC | |
| PH_BPI_BANKO | |
| PH_CIMB | |
| PH_BANKFLORIDAPH | |
| PH_GUINOBATAN | |
| PH_HSBCSB | |
| PH_CAMALIG | |
| PH_COUNTRY_BUILDERS | |
| PH_RANGAY_BANK | |
| PH_COINSPH | |
| PH_CARDBANK | |
CurrencyISO4217
CurrencyISO4217 iso is the 3 digit currency that will be used as standard currency type on fast checkout. see: https://en.wikipedia.org/wiki/ISO_4217
| Value | Description |
|---|
| UNKNOWN_CURRENCY | |
| AFN | |
| EUR | |
| ALL | |
| DZD | |
| USD | |
| AOA | |
| XCD | |
| ARS | |
| AMD | |
| AWG | |
| AUD | |
| AZN | |
| BSD | |
| BHD | |
| BDT | |
| BYR | |
| BZD | |
| XOF | |
| BMD | |
| BTN | |
| BOV | |
| BAM | |
| BWP | |
| NOK | |
| BRL | |
| SGD | |
| BGN | |
| BIF | |
| KHR | |
| XAF | |
| CAD | |
| CVE | |
| KYD | |
| CLP | |
| CNY | |
| COP | |
| KMF | |
| CDF | |
| NZD | |
| CRC | |
| HRK | |
| CUC | |
| CZK | |
| DKK | |
| DJF | |
| DOP | |
| EGP | |
| ERN | |
| ETB | |
| FKP | |
| FJD | |
| XPF | |
| GMD | |
| GEL | |
| GHS | |
| GIP | |
| GTQ | |
| GBP | |
| GNF | |
| GYD | |
| HNL | |
| HKD | |
| HUF | |
| ISK | |
| INR | |
| IDR | |
| IRR | |
| IQD | |
| IMP | |
| ILS | |
| JMD | |
| JPY | |
| JEP | |
| JOD | |
| KZT | |
| KES | |
| KPW | |
| KRW | |
| KWD | |
| KGS | |
| LAK | |
| LBP | |
| LSL | |
| LRD | |
| LYD | |
| CHF | |
| MKD | |
| MGA | |
| MWK | |
| MYR | |
| MVR | |
| MRO | |
| MUR | |
| MXN | |
| MDL | |
| MNT | |
| MAD | |
| MZN | |
| MMK | |
| NAD | |
| NPR | |
| ANG | |
| NIO | |
| NGN | |
| OMR | |
| PKR | |
| PGK | |
| PYG | |
| PEN | |
| PHP | |
| PLN | |
| QAR | |
| RON | |
| RUB | |
| RWF | |
| WST | |
| STD | |
| SAR | |
| RSD | |
| SCR | |
| SLL | |
| SBD | |
| SOS | |
| ZAR | |
| SSP | |
| LKR | |
| SHP | |
| SDG | |
| SRD | |
| SZL | |
| SEK | |
| SYP | |
| TWD | |
| TJS | |
| TZS | |
| THB | |
| TOP | |
| TTD | |
| TND | |
| TRY | |
| TMT | |
| UGX | |
| UAH | |
| ARE | |
| UYU | |
| UZS | |
| VUV | |
| VEF | |
| VND | |
| YER | |
| ZRN | |
| ZMW | |
SettlementResponseCode
| Value | Description |
|---|
| UNKNOWN_CODE | |
| GR001 | |
| GR011 | |
| GR032 | |
| GR036 | |
| GR092 | |
| RM021 | |
| RM022 | |
| RM036 | |
Via
Via is the fund transfer rail enum.
| Value | Description |
|---|
| UNKNOWN_Via | |
| INTRABANK | |
| IDONLINE | |
| IDLLG | |
| IDRTGS | |
| PHINSTAPAY | |
| PHPESONET | |
Example:
{
"transfers": [
{
"status": "Status",
"from": {
"type": "AccountInfoType",
"bank_code": "BankCode",
"account_number": "string",
"identifier": "string",
"holder_name": "string",
"country": "CountryISO3166"
},
"to": {
"type": "AccountInfoType",
"bank_code": "DestinationBankCode",
"account_number": "string",
"identifier": "string",
"holder_name": "string",
"holder_first_name": "string",
"holder_middle_name": "string",
"holder_last_name": "string",
"email_address": "string",
"mobile_country_code": "string",
"mobile_number": "string",
"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"country": "string"
},
"amount": {
"cur": "CurrencyISO4217",
"num": "string"
},
"user_memo": "string",
"bank_memo": "string",
"created": {
"seconds": "int64",
"nanos": "int32"
},
"completed": {
"seconds": "int64",
"nanos": "int32"
},
"payment_channel": "string",
"settlement": {
"settlement_id": "string",
"settlement_response_id": "string",
"settlement_response_code": "SettlementResponseCode",
"settlement_response_status": "string",
"settlement_timestamp": {
"seconds": "int64",
"nanos": "int32"
}
},
"customer": {
"fname": "string",
"lname": "string",
"mname": "string",
"email": "string",
"mobile": "string",
"phone": "string",
"customer_id": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"province": "string",
"zip_code": "string",
"country": "string"
}
},
"transfer_id": "string",
"updated": {
"seconds": "int64",
"nanos": "int32"
},
"reference_id": "string",
"bank_ref_code": "string",
"org_id": "string",
"consent_granted": "bool",
"additional_details": {
"qr_code": "string",
"account_alias_id": "string",
"to_address_line1": "string",
"to_address_line2": "string",
"to_city": "string",
"to_state": "string",
"to_country": "string",
"terms_of_use_version": "string",
"privacy_policy_version": "string",
"user_id_hash": "string",
"user_access_hash": "string",
"user_account_hash": "string",
"via": "Via",
"bank_fee": {
"cur": "CurrencyISO4217",
"num": "string"
}
},
"bank_interaction_method": "BankInteractionMethod"
}
],
"next_page": "int32"
}
Response codes
| Status | Description |
|---|
| 200 | Request executed successfully. |
| 404 | Returned when the resource is not found. |
| 400 | Returned when the request body is malformatted or does not match the expected request. |
| 401 | Returned when the request does not contains the user’s credentials. |
| 403 | Returned when the user does not have permission to access the resource. |
| 500 | Returned when an unexpected error occured on the server side. |
