Account Opening API v1.0.0

Brankas Account Opening provides Marketplace, p2p, fintech, or any 3rd parties platform to provide account opening services in their platform. This allow 3rd parties user access for saving and credit account by banks. By connecting end-user and Banks, Brankas Account Opening enable access over a growing basket of banks and banks products via a single set of APIs.

  • Host https://account-opening.sandbox.bnk.to

API Reference Overview

Get Saving Product List

Get Saving Product List returns list of available banks and their saving products for customer to apply

curl -X GET \
	https://account-opening.sandbox.bnk.to/v1/product-list \
	-H 'x-api-key: USE_YOUR_API_KEY'

HTTP Request

GET https://account-opening.sandbox.bnk.to/v1/product-list

Responses

Response body

Name Type Description
banks []Bank Banks list of available bank to apply
Objects
Bank
Name Type Description
code string Code is brankas internal code for the bank
name string Name is the name of the bank
logo_url string LogoURL is url of the bank logo
products []BankProduct Products is the list of available bank products to apply
BankProduct
Name Type Description
code string Code is the brankas internal code for the bank product
name string Name is the name of the bank product
description string Description is the description of the bank
interest string Interest is the amount of the bank interest
facilities []string Facilities is the provided facilities by the bank for the product
requirements []string Requirements is the requirements for user to apply the product
costs []string Costs is the cost related to the product

Example:

{
  "banks": [
    {
      "code": "MANDIRI",
      "name": "Bank Mandiri",
      "logo_url": "https://storage.googleapis.com/brankas-account-opening-logos/MANDIRI/MANDIRI.png",
      "products": [
        {
          "code": "MANDIRI_NOW",
          "name": "Mandiri Tabungan Now",
          "description": "Mandiri Tabungan Now menawarkan kemudahan dan kenyamanan buat kamu mulai dari membuka tabungan #gapakedonlot sampai dengan bertransaksi di mana saja dan kapan saja. Pilih Mandiri Tabungan NOW untuk kemudahan dan kenyamanan transaksi mu.",
          "interest": "2.50%",
          "facilities": [
            "Gratis biaya administrasi rekening selama 6 bulan",
            "Transaksi menggunakan kartu mandiri debit visa/gpn",
            "Fasilitas loyalty mandiri fiestapoin",
            "Fasilitas mandiri e-statement yang dikirimkan melalui email setiap bulan"
          ],
          "requirements": [
            "KTP",
            "NPWP",
            "Tanda tangan di kertas putih"
          ],
          "costs": [
            "Setoran Awal Rp50.000,00",
            "Saldo minimum Rp10.000,00",
            "Biaya administrasi rekening Rp2.500",
            "Biaya administrasi kartu mandiri debit menyesuaikan dengan jenis kartu yang dipilih"
          ]
        }
      ]
    }
  ]
}

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 occurred on the server side.

Open Account

Open Account allows customers to apply to open an account with the selected bank products

curl -X POST \
	https://account-opening.sandbox.bnk.to/v1/open-account \
	-H 'x-api-key: USE_YOUR_API_KEY' \
	-d '{
		"reference_id": "REF-xxxx-123",
		"bank_code": "MANDIRI",
		"product_code": "MANDIRI_NOW",
		"user_detail": {
			"user_name": "John Johnson Joseph",
			"user_phone_number": "+62-283-5559-907",
			"user_email": "john.johnson@domain.com"
		}
	}'

HTTP Request

POST https://account-opening.sandbox.bnk.to/v1/open-account

Body Parameters

Name Type Description
reference_id string ReferenceID is an optional reference id for the open account request.
bank_code BankCode BankCode is the bank code of the targated bank for the open account request
product_code BankProductCode BankCode is the product code of the selected bank product for the open account request
user_detail UserDetail UserDetail is the user information requesting to open an account.
Objects
UserDetail
Name Type Description
user_name string UserName is the name of the user
user_phone_number string UserPhoneNumber is the phone number of the user
user_email string UserEmail is the email address of the user
Enums
BankCode

BankCode is the internal code (enum) used by the service to target a specific bank for the account opening request.

Value Description
UNKNOWN_BANK Unknown / Invalid Bank Code
DUMMY_BANK DUMMY BANK
MANDIRI PT. BANK MANDIRI (PERSERO), TBK
BankProductCode

BankProductCode is the internal code (enum) used by the service to target a specific bank product for the account opening request.

Value Description
UNKNOWN_PRODUCT Unknown / Invalid Bank Product Code
DUMMY_PRODUCT DUMMY PRODUCT
MANDIRI_NOW Mandiri Tabungan Now

Responses

Response body

Name Type Description
application_id string ApplicationID is the unique identifier of the application
application_url string ApplicationURL is the url for the customer to visit, to continue the open account process
reference_id string ReferenceID is the optional reference identifier provided for the application during open account request

Example:

{
  "application_id": "137f9032-ae1e-11eb-a0b8-0242ac1d0002",
  "application_url": "https://join.bankmandiri.co.id/app",
  "reference_id": "REF-xxxx-123"
}

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 occurred on the server side.

Status Inquiry

Status Inquiry return the current status of the requested application

curl -X POST \
	https://account-opening.sandbox.bnk.to/v1/status-inquiry \
	-H 'x-api-key: USE_YOUR_API_KEY' \
	-d '{
		"application_id": "137f9032-ae1e-11eb-a0b8-0242ac1d0002"
	}'

HTTP Request

POST https://account-opening.sandbox.bnk.to/v1/status-inquiry

Body Parameters

Name Type Description
application_id string ApplicationID is the unique identifier of the application

Responses

Response body

Name Type Description
status Status Status is the current status of the requested application
reference_id string ReferenceID is the optional reference identifier provided for the application during open account request
Enums
Status

Status describe the status of the application

Value Description
UNKNOWN_STATUS Unknown / Invalid status
PENDING Application is in queue and will be process
SENT Application data has been submitted
PROCESSING Application is being process by the bank
CREATED Account has been created
REJECTED Application request is rejected

Example:

{
  "status": "SENT",
  "reference_id": "REF-xxxx-123"
}

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 occurred on the server side.