User guide:
Instruction manual

Step 1

Sign up for an account

Register for an account to discover and experience BIDV's products and services provided via Open API. Register for an account through the following instructions:

The activation email is valid within 48 hours. Click on the email link to activate the account.

Note: If you do not receive the email, please check your spam folder.

Step 2

Create applications and choose products and services

Go to the applications menu , select Create a new application , the screen displays the information fields you need to enter.

More on the fields:

Title : (Required) - The name of your app.

Certificate (Required) - Upload an X509 certificate (PEM format).

Description (Optional) - Enter a brief description of what your app does

Application Oauth Redirect URL (Optional) - Defines the URL for the application to receive the code after authentication, this code is used in exchange for an access token to call the API.

Application symmetric key (Optional) - A symmetric cipher used to encrypt and decrypt information.

Application whitelist IP (Optional) - A list of IP address ranges that are granted access to the system.

Client ID and Client Secret

After creating the app, you will get your Client ID and Client Secret, copy these values and keep it in a safe place, if you lose it, you will have to get a new key pair.

Client ID - Your application's public identifier, this field represents the information of the partner when using the API.

Client Secret - Format your application's top secret, this field allows us to verify your application information and serve authentic application.

Note : Client ID and Client Secret are a key pair that identifies you as an authenticated person and can protect yourself and your clients, please keep them in a safe place.

Select a product.

Sign up for an API plan in the product.

Step 3

Experience our APIs

You can test your application with a test tool that can generate RestAPI calls, such as SOAP UI, Postman.

Furthermore, you can test the service on the website.

To test the service, follow these instructions:

Select the APIs menu , select the service you want to experience.

To try it out, please select an API from the API list. Service details contain information about API Endpoints, API security, API parameters, and response parameters that will be expressed as simple data and templates.

You can also download the API documentation in YAML format, which provides full API details, including information about Endpoints, API security, API parameters...

In addition to experiencing the API directly, you can choose the Try it feature.

You need to get the Access token to get permission to use the API. To get the Access token, enter the API Secret, then click "Get Token".
Try calling the API on the Try it page.
Fill in the API information and select "Generate" to generate new sample data, then click "Send" to get the response.

Step 4

Integration and testing

For parnership, integration and testing requirements, please select HERE or call us at 19009247.
Get test environment connection information, conduct integration and testing.

Get test environment connection information, conduct integration and testing.

Step 5

Prepare deployment conditions

Confirm test completion and request go live.

Get Production environment connection information.

Step 6

Go live the product

Deploy to Production environment.

User guide:
Instruction manual

Step 1

Sign up for an account

Register for an account to discover and experience BIDV's products and services provided via Open API. Register for an account through the following instructions:

The activation email is valid within 48 hours. Click on the email link to activate the account.

Note: If you do not receive the email, please check your spam folder.

Step 2

Create applications and choose products and services

Go to the applications menu , select Create a new application , the screen displays the information fields you need to enter.

More on the fields:

Title : (Required) - The name of your app.

Certificate (Required) - Upload an X509 certificate (PEM format).

Description (Optional) - Enter a brief description of what your app does

Application Oauth Redirect URL (Optional) - Defines the URL for the application to receive the code after authentication, this code is used in exchange for an access token to call the API.

Application symmetric key (Optional) - A symmetric cipher used to encrypt and decrypt information.

Application whitelist IP (Optional) - A list of IP address ranges that are granted access to the system.

Client ID and Client Secret

After creating the app, you will get your Client ID and Client Secret, copy these values and keep it in a safe place, if you lose it, you will have to get a new key pair.

Client ID - Your application's public identifier, this field represents the information of the partner when using the API.

Client Secret - Format your application's top secret, this field allows us to verify your application information and serve authentic application.

Note : Client ID and Client Secret are a key pair that identifies you as an authenticated person and can protect yourself and your clients, please keep them in a safe place.

Select a product.

Sign up for an API plan in the product.

Step 3

Experience our APIs

You can test your application with a test tool that can generate RestAPI calls, such as SOAP UI, Postman.

Furthermore, you can test the service on the website.

To test the service, follow these instructions:

Select the APIs menu , select the service you want to experience.

To try it out, please select an API from the API list. Service details contain information about API Endpoints, API security, API parameters, and response parameters that will be expressed as simple data and templates.

You can also download the API documentation in YAML format, which provides full API details, including information about Endpoints, API security, API parameters...

In addition to experiencing the API directly, you can choose the Try it feature.

You need to get the Access token to get permission to use the API. To get the Access token, enter the API Secret, then click "Get Token".
Try calling the API on the Try it page.
Fill in the API information and select "Generate" to generate new sample data, then click "Send" to get the response.

Step 4

Integration and testing

For parnership, integration and testing requirements, please select HERE or call us at 19009247.
Get test environment connection information, conduct integration and testing.

Get test environment connection information, conduct integration and testing.

Step 5

Prepare deployment conditions

Confirm test completion and request go live.

Get Production environment connection information.

Step 6

Go live the product

Deploy to Production environment.