Accounts & Transaction Information Service Package

1.4.3

Tóm tắt

A comprehensive API package enabling partners to retrieve real-time account details, balances, transaction history, and account statements for seamless system integration.

Overview
API List

APIs

View Recent Transaction History by Account No

1.0.0

API tra cứu lịch sử giao dịch theo số tài khoản của khách hàng doanh nghiệp.

Tài khoản truy vấn phải thuộc về CIF của client; chỉ cho phép tra cứu giao dịch trong khoảng thời gian T-2 đến T (T là ngày hiện tại).

This API allows corporate customers to inquire the transaction history of an account they own. The account must belong to the client's CIF, and only transactions within the T-2 to T window (T = current date) can be retrieved.

REST

Online
Inquiry List of Account by CIF v2

1.0.0

API tra cứu danh sách tài khoản thanh toán theo CIF (xác định từ clientId) kèm thông tin số dư tối thiểu.

This API allows corporate customers to query the list of payment accounts belonging to their CIF (resolved from clientId) with minimum balance info.

REST

Online
Query Debit Restriction Status

1.0.0

API tra cứu trạng thái xử lý yêu cầu thiết lập/hủy hạn chế ghi nợ tài khoản thanh toán theo transactionId.

This API allows corporate customers to query the processing status of a debit restriction SET/REMOVE request by transactionId.

REST

Online
Set Remove Debit Restriction

1.0.0

API cho phép KHDN thiết lập hoặc hủy bỏ hạn chế "Không được ghi nợ" đối với một hoặc nhiều tài khoản thanh toán thuộc CIF thông qua Open API của OCB.

This API allows corporate customers to set or remove the "No Debit" restriction on one or multiple payment accounts under the same CIF through OCB Open API.

REST

Online
View Transaction History by Account No

1.2.3

Retrieve transaction history information by account

REST

Online
Transaction History Report By Account No

1.0.6

The API will perform the retrieval of information and export the transaction statement file

REST

Online
View Transaction of Topup Agent service

1.0.5

Query recharge status such as mobile, flight ticket. Currently only available through Bamboo Airway

REST

Online
Inquiry List of Account by CIF (Customer ID)

1.0.5

Display the list of existing accounts by customer ID (CIF)

REST

Online
Inquiry Account Details by Account List

1.1.0

Display account details by account number and customer ID (CIF

REST

Online
Ewallet Transaction Report

1.0.5

Query transaction history on E-Wallet

REST

Online
API Total number and sum amount of transactions by account no

1.0.2

Allow user to query transaction number by account number - Giúp truy vấn số lượng giao dịch trong ngày sao kê bằng số tài khoản

REST

Online

Plans

In order to subscribe, you must create an account or sign in.

Default Plan

1000 calls per minute

Select

Default Plan

11 APIs including

API Total number and sum amount of transactions by account no 1.0.2
Ewallet Transaction Report 1.0.5
Inquiry Account Details by Account List 1.1.0
Inquiry List of Account by CIF (Customer ID) 1.0.5
View Transaction of Topup Agent service 1.0.5

View details

APIs

Title	Version	Type	Rate limits
API Total number and sum amount of transactions by account no	1.0.2	REST	1000 calls per minute
POST /account/total-number-transactions			1000 calls per minute
PARAMETERS /account/total-number-transactions			1000 calls per minute
Ewallet Transaction Report	1.0.5	REST	1000 calls per minute
POST /account/ewallet-transaction-report			1000 calls per minute
Inquiry Account Details by Account List	1.1.0	REST	1000 calls per minute
POST /accounts/details			1000 calls per minute
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	1000 calls per minute
POST /accounts			1000 calls per minute
View Transaction of Topup Agent service	1.0.5	REST	1000 calls per minute
POST /topup/transactions			1000 calls per minute
Transaction History Report By Account No	1.0.6	REST	1000 calls per minute
POST /account/transactions-report			1000 calls per minute
View Transaction History by Account No	1.2.3	REST	1000 calls per minute
POST /account/transactions			1000 calls per minute
Query Debit Restriction Status	1.0.0	REST	1000 calls per minute
POST /accounts/debit-restriction/status			1000 calls per minute
Set Remove Debit Restriction	1.0.0	REST	1000 calls per minute
POST /accounts/debit-restriction			1000 calls per minute
Inquiry List of Account by CIF v2	1.0.0	REST	1000 calls per minute
POST /accounts/list			1000 calls per minute
View Recent Transaction History by Account No	1.0.0	REST	1000 calls per minute
POST /accounts/transaction-history			1000 calls per minute

Momo Plan

1000 calls per hour

Select

Momo Plan

9 APIs including

Ewallet Transaction Report 1.0.5
Inquiry Account Details by Account List 1.1.0
Inquiry List of Account by CIF (Customer ID) 1.0.5
Transaction History Report By Account No 1.0.6
View Transaction History by Account No 1.2.3

View details

APIs

Title	Version	Type	Rate limits
Ewallet Transaction Report	1.0.5	REST	1000 calls per hour
POST /account/ewallet-transaction-report			1000 calls per hour
Inquiry Account Details by Account List	1.1.0	REST	1000 calls per hour
POST /accounts/details			1000 calls per hour
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	1000 calls per hour
POST /accounts			1000 calls per hour
Transaction History Report By Account No	1.0.6	REST	1000 calls per hour
POST /account/transactions-report			1000 calls per hour
View Transaction History by Account No	1.2.3	REST	1000 calls per hour
POST /account/transactions			1000 calls per hour
Query Debit Restriction Status	1.0.0	REST	1000 calls per hour
POST /accounts/debit-restriction/status			1000 calls per hour
Set Remove Debit Restriction	1.0.0	REST	1000 calls per hour
POST /accounts/debit-restriction			1000 calls per hour
Inquiry List of Account by CIF v2	1.0.0	REST	1000 calls per hour
POST /accounts/list			1000 calls per hour
View Recent Transaction History by Account No	1.0.0	REST	1000 calls per hour
POST /accounts/transaction-history			1000 calls per hour

Mecorp Plan

2000 calls per day

Select

Mecorp Plan

7 APIs including

Inquiry Account Details by Account List 1.1.0
Inquiry List of Account by CIF (Customer ID) 1.0.5
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0

View details

APIs

Title	Version	Type	Rate limits
Inquiry Account Details by Account List	1.1.0	REST	2000 calls per day
POST /accounts/details			2000 calls per day
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	2000 calls per day
POST /accounts			2000 calls per day
View Transaction History by Account No	1.2.3	REST	2000 calls per day
POST /account/transactions			2000 calls per day
Query Debit Restriction Status	1.0.0	REST	2000 calls per day
POST /accounts/debit-restriction/status			2000 calls per day
Set Remove Debit Restriction	1.0.0	REST	2000 calls per day
POST /accounts/debit-restriction			2000 calls per day
Inquiry List of Account by CIF v2	1.0.0	REST	2000 calls per day
POST /accounts/list			2000 calls per day
View Recent Transaction History by Account No	1.0.0	REST	2000 calls per day
POST /accounts/transaction-history			2000 calls per day

Transactions View Plan

2 rate limits *

Select

Transactions View Plan

6 APIs including

Inquiry Account Details by Account List 1.1.0
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0
Inquiry List of Account by CIF v2 1.0.0

View details

Transactions View Plan

APIs

Title	Version	Type	Rate limits
Inquiry Account Details by Account List	1.1.0	REST	2 rate limits *
POST /accounts/details			2 rate limits *
View Transaction History by Account No	1.2.3	REST	2 rate limits *
POST /account/transactions			2 rate limits *
Query Debit Restriction Status	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction/status			2 rate limits *
Set Remove Debit Restriction	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction			2 rate limits *
Inquiry List of Account by CIF v2	1.0.0	REST	2 rate limits *
POST /accounts/list			2 rate limits *
View Recent Transaction History by Account No	1.0.0	REST	2 rate limits *
POST /accounts/transaction-history			2 rate limits *

Full Option Basic

9200 calls per day

Select

Full Option Basic Plan

7 APIs including

Inquiry List of Account by CIF (Customer ID) 1.0.5
Inquiry Account Details by Account List 1.1.0
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0

View details

APIs

Title	Version	Type	Rate limits
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	9200 calls per day
POST /accounts			9200 calls per day
Inquiry Account Details by Account List	1.1.0	REST	9200 calls per day
POST /accounts/details			9200 calls per day
View Transaction History by Account No	1.2.3	REST	9200 calls per day
POST /account/transactions			9200 calls per day
Query Debit Restriction Status	1.0.0	REST	9200 calls per day
POST /accounts/debit-restriction/status			9200 calls per day
Set Remove Debit Restriction	1.0.0	REST	9200 calls per day
POST /accounts/debit-restriction			9200 calls per day
Inquiry List of Account by CIF v2	1.0.0	REST	9200 calls per day
POST /accounts/list			9200 calls per day
View Recent Transaction History by Account No	1.0.0	REST	9200 calls per day
POST /accounts/transaction-history			9200 calls per day

Economic Plan

2 rate limits *

Select

Info Retrieving Plan – Economic

6 APIs including

Inquiry Account Details by Account List 1.1.0
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0
Inquiry List of Account by CIF v2 1.0.0

View details

Economic Plan

Info Retrieving Plan – Economic

APIs

Title	Version	Type	Rate limits
Inquiry Account Details by Account List	1.1.0	REST	2 rate limits *
POST /accounts/details			2 rate limits *
View Transaction History by Account No	1.2.3	REST	2 rate limits *
POST /account/transactions			2 rate limits *
Query Debit Restriction Status	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction/status			2 rate limits *
Set Remove Debit Restriction	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction			2 rate limits *
Inquiry List of Account by CIF v2	1.0.0	REST	2 rate limits *
POST /accounts/list			2 rate limits *
View Recent Transaction History by Account No	1.0.0	REST	2 rate limits *
POST /accounts/transaction-history			2 rate limits *

Premier Plan

2 rate limits *

Select

Info Retrieving Plan – Premier

6 APIs including

Inquiry Account Details by Account List 1.1.0
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0
Inquiry List of Account by CIF v2 1.0.0

View details

Premier Plan

Info Retrieving Plan – Premier

APIs

Title	Version	Type	Rate limits
Inquiry Account Details by Account List	1.1.0	REST	2 rate limits *
POST /accounts/details			2 rate limits *
View Transaction History by Account No	1.2.3	REST	2 rate limits *
POST /account/transactions			2 rate limits *
Query Debit Restriction Status	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction/status			2 rate limits *
Set Remove Debit Restriction	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction			2 rate limits *
Inquiry List of Account by CIF v2	1.0.0	REST	2 rate limits *
POST /accounts/list			2 rate limits *
View Recent Transaction History by Account No	1.0.0	REST	2 rate limits *
POST /accounts/transaction-history			2 rate limits *

Ultimate Plan

2 rate limits *

Select

Info Retrieving Plan – Ultimate

6 APIs including

Inquiry Account Details by Account List 1.1.0
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0
Inquiry List of Account by CIF v2 1.0.0

View details

Ultimate Plan

Info Retrieving Plan – Ultimate

APIs

Title	Version	Type	Rate limits
Inquiry Account Details by Account List	1.1.0	REST	2 rate limits *
POST /accounts/details			2 rate limits *
View Transaction History by Account No	1.2.3	REST	2 rate limits *
POST /account/transactions			2 rate limits *
Query Debit Restriction Status	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction/status			2 rate limits *
Set Remove Debit Restriction	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction			2 rate limits *
Inquiry List of Account by CIF v2	1.0.0	REST	2 rate limits *
POST /accounts/list			2 rate limits *
View Recent Transaction History by Account No	1.0.0	REST	2 rate limits *
POST /accounts/transaction-history			2 rate limits *

GHTK

2 rate limits *

Select

GHTK

7 APIs including

Inquiry Account Details by Account List 1.1.0
Inquiry List of Account by CIF (Customer ID) 1.0.5
View Transaction History by Account No 1.2.3
Query Debit Restriction Status 1.0.0
Set Remove Debit Restriction 1.0.0

View details

APIs

Title	Version	Type	Rate limits
Inquiry Account Details by Account List	1.1.0	REST	2 rate limits *
POST /accounts/details			2 rate limits *
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	2 rate limits *
POST /accounts			2 rate limits *
View Transaction History by Account No	1.2.3	REST	2 rate limits *
POST /account/transactions			2 rate limits *
Query Debit Restriction Status	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction/status			2 rate limits *
Set Remove Debit Restriction	1.0.0	REST	2 rate limits *
POST /accounts/debit-restriction			2 rate limits *
Inquiry List of Account by CIF v2	1.0.0	REST	2 rate limits *
POST /accounts/list			2 rate limits *
View Recent Transaction History by Account No	1.0.0	REST	2 rate limits *
POST /accounts/transaction-history			2 rate limits *

Transaction Report Plan

1000 calls per minute

Select

Transaction Report Plan

11 APIs including

API Total number and sum amount of transactions by account no 1.0.2
Ewallet Transaction Report 1.0.5
Inquiry Account Details by Account List 1.1.0
Inquiry List of Account by CIF (Customer ID) 1.0.5
View Transaction of Topup Agent service 1.0.5

View details

APIs

Title	Version	Type	Rate limits
API Total number and sum amount of transactions by account no	1.0.2	REST	1000 calls per minute
POST /account/total-number-transactions			1000 calls per minute
PARAMETERS /account/total-number-transactions			1000 calls per minute
Ewallet Transaction Report	1.0.5	REST	1000 calls per minute
POST /account/ewallet-transaction-report			1000 calls per minute
Inquiry Account Details by Account List	1.1.0	REST	1000 calls per minute
POST /accounts/details			1000 calls per minute
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	1000 calls per minute
POST /accounts			1000 calls per minute
View Transaction of Topup Agent service	1.0.5	REST	1000 calls per minute
POST /topup/transactions			1000 calls per minute
Transaction History Report By Account No	1.0.6	REST	1000 calls per minute
POST /account/transactions-report			1000 calls per minute
View Transaction History by Account No	1.2.3	REST	1000 calls per minute
POST /account/transactions			1000 calls per minute
Query Debit Restriction Status	1.0.0	REST	1000 calls per minute
POST /accounts/debit-restriction/status			1000 calls per minute
Set Remove Debit Restriction	1.0.0	REST	1000 calls per minute
POST /accounts/debit-restriction			1000 calls per minute
Inquiry List of Account by CIF v2	1.0.0	REST	1000 calls per minute
POST /accounts/list			1000 calls per minute
View Recent Transaction History by Account No	1.0.0	REST	1000 calls per minute
POST /accounts/transaction-history			1000 calls per minute

Full Options Advanced

40000 calls per day

Select

Full Options Advanced

11 APIs including

API Total number and sum amount of transactions by account no 1.0.2
Ewallet Transaction Report 1.0.5
Inquiry Account Details by Account List 1.1.0
Inquiry List of Account by CIF (Customer ID) 1.0.5
View Transaction of Topup Agent service 1.0.5

View details

APIs

Title	Version	Type	Rate limits
API Total number and sum amount of transactions by account no	1.0.2	REST	40000 calls per day
POST /account/total-number-transactions			40000 calls per day
PARAMETERS /account/total-number-transactions			40000 calls per day
Ewallet Transaction Report	1.0.5	REST	40000 calls per day
POST /account/ewallet-transaction-report			40000 calls per day
Inquiry Account Details by Account List	1.1.0	REST	40000 calls per day
POST /accounts/details			40000 calls per day
Inquiry List of Account by CIF (Customer ID)	1.0.5	REST	40000 calls per day
POST /accounts			40000 calls per day
View Transaction of Topup Agent service	1.0.5	REST	40000 calls per day
POST /topup/transactions			40000 calls per day
Transaction History Report By Account No	1.0.6	REST	40000 calls per day
POST /account/transactions-report			40000 calls per day
View Transaction History by Account No	1.2.3	REST	40000 calls per day
POST /account/transactions			40000 calls per day
Query Debit Restriction Status	1.0.0	REST	40000 calls per day
POST /accounts/debit-restriction/status			40000 calls per day
Set Remove Debit Restriction	1.0.0	REST	40000 calls per day
POST /accounts/debit-restriction			40000 calls per day
Inquiry List of Account by CIF v2	1.0.0	REST	40000 calls per day
POST /accounts/list			40000 calls per day
View Recent Transaction History by Account No	1.0.0	REST	40000 calls per day
POST /accounts/transaction-history			40000 calls per day