Payment Services Package - OCB API Developer Portal

Summary

- Currently, cashless payment is a growing trend in financial transactions. OCB understands that it is necessary to have more payment applications to connect banks to accept payments. With payment APIs, OCB can support organizations and businesses to build payment applications at a low cost. In addition, this package can be used to integrate payment features for e-commerce websites or mobile payment applications.
- Hiện nay, thế giới không có tiền mặt là xu hướng phát triển trong giao dịch tài chính, OCB hiểu rằng cần thêm ứng dụng thanh toán để kết nối ngân hàng để chấp nhận thanh toán. Với các API phục vụ cho việc thanh toán, OCB có thể hỗ trợ các tổ chức, doanh nghiệp xây dựng các ứng dụng thanh toán với mức phí thấp. Ngoài ra, có thể sử dụng gói sản phẩm này để tích hợp các tính năng thanh toán cho trang web thương mại điện tử hoặc ứng dụng thanh toán di động.

APIs

Bill Payment

1.0.6

Through this API, customers can pay different types of invoices without using intermediary payment gateways

REST

Online
Check Transfer Status (Approved on OMNI Corp)

1.0.4

API giúp truy vấn trạng thái giao dịch được xử lý trên OMNI CORP của OCB sau khi thực hiện lệnh chuyển tiền, thanh toán.

The API inquires the transaction status on OMNI CORP after making the payment order(s).

REST

Online
Create Batch Collection Order (Approving on Omni Corporate)

1.0.4

Dùng để gửi lô lệnh thu trong hệ thống OCB. Người dùng thực hiện gửi lô lệnh từ hệ thống ERP/hệ thống kế toán đến OCB và duyệt trên Omni.

API is used for batch collection OCB. Users create the order on the ERP/Accounting system and approve on OMNI.

REST

Online
Create Batch Transfer Order (Approving on Omni Corporate)

1.0.3

Dùng để gửi lô lệnh chuyển tiền trong/ngoài hệ thống OCB. Người dùng thực hiện gửi lô lệnh từ hệ thống ERP/hệ thống kế toán đến OCB và duyệt trên Omni.

API is used for batch internal OCB or interbank domestic transfer. Users create the order on the ERP/Accounting system and approve on OMNI.

REST

Online
Create Domestic Transfer Order (Approving on OMNI Corporate)

1.0.3

API is used for interbank domestic transfer. Users create the order on the ERP/Accounting system and approve on OMNI.

REST

Online
Create Fast Transfer Order (Approving on OMNI Corporate)

1.0.3

API is used for interbank fast transfer. Users create the order on the ERP/Accounting system and approve on OMNI.

REST

Online
Create Internal Transfer Order (Approving on OMNI Corporate)

1.0.3

API is used for internal OCB transfer. Users create the order on the ERP/Accounting system and approve on OMNI.

REST

Online
Create Transfer Order (Approving on OMNI Corporate)

1.0.3

The API sends the customer‘s payment card/account information when making a payment

REST

Online
Get Credit Advice (Batch Transfer order approved on Omni)

1.0.1

Dùng để lấy file giấy báo có nếu phát sinh các giao dịch không thành công trong lô giao dịch (duyệt trên Omni).

API is used to get credit advices of the batch transfer order. Users create the order on the ERP/Accounting system and approve on OMNI. If there are any unsuccessul transactions in the order, credit advices can be got.

REST

Online
Get list services of suppliers

1.0.4

API helps to access the list of types that can pay bills (Example: electricity, water, Internet ...)

REST

Online
Get Payment Order (Approved on OMNI Corp)

1.0.2

API is used for getting payment order in PDF and XML fomat after users approved on OMNI.

REST

Online
Inquiry List of Suppliers

1.0.4

API helps access the list of service providers such as electricity (EVN), water (Sawaco), Internet (FPT, Viettel, VNPT) …

REST

Online
Retrieve Bill information

1.0.5

API provides invoice information such as owner name, invoice type, supplier information, amount, payment period

REST

Online
View batch fund transfer order status (Approving on OMNI Corporate)

1.0.6

API được sử dụng để truy vấn lịch sử giao dịch chuyển tiền theo lô trong nội bộ OCB/ chuyển tiền nhanh theo lô/ chuyển tiền liên ngân hàng thông thường theo lô

API is used for viewing the transaction history of batch internal transfer/ batch fast transfer/ batch interbank transfer

REST

Online

Plans

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

Default Plan

1000 calls per minute

Select

Default Plan

14 APIs including

Bill Payment 1.0.6
Check Transfer Status (Approved on OMNI Corp) 1.0.4
Create Batch Collection Order (Approving on Omni Corporate) 1.0.4
Create Batch Transfer Order (Approving on Omni Corporate) 1.0.3
Create Domestic Transfer Order (Approving on OMNI Corporate) 1.0.3

View details

APIs

Title	Version	Type	Rate limits
Bill Payment	1.0.6	REST	1000 calls per minute
POST /payment/billPayment			1000 calls per minute
Check Transfer Status (Approved on OMNI Corp)	1.0.4	REST	1000 calls per minute
POST /payment/check-transfer-status-on-omni			1000 calls per minute
Create Batch Collection Order (Approving on Omni Corporate)	1.0.4	REST	1000 calls per minute
POST /payment/create-batch-collection-order			1000 calls per minute
Create Batch Transfer Order (Approving on Omni Corporate)	1.0.3	REST	1000 calls per minute
POST /payment/create-batch-transfer-order-omni			1000 calls per minute
Create Domestic Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	1000 calls per minute
POST /payment/create-domestic-transfer-order			1000 calls per minute
Create Fast Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	1000 calls per minute
POST /oimt/create-fast-transfer-order			1000 calls per minute
Create Internal Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	1000 calls per minute
POST /payment/create-internal-transfer-order			1000 calls per minute
Create Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	1000 calls per minute
POST /payment/create-transfer-order			1000 calls per minute
Get Credit Advice (Batch Transfer order approved on Omni)	1.0.1	REST	1000 calls per minute
POST /omni/get-credit-advice-on-omni			1000 calls per minute
Get list services of suppliers	1.0.4	REST	1000 calls per minute
POST /payment/selectPartnerServiceCode			1000 calls per minute
Get Payment Order (Approved on OMNI Corp)	1.0.2	REST	1000 calls per minute
POST /payment/get-payment-order			1000 calls per minute
Inquiry List of Suppliers	1.0.4	REST	1000 calls per minute
POST /payment/selectPartnerProviderCode			1000 calls per minute
Retrieve Bill information	1.0.5	REST	1000 calls per minute
POST /payment/retrievePartnerBill			1000 calls per minute
View batch fund transfer order status (Approving on OMNI Corporate)	1.0.6	REST	1000 calls per minute
POST /omni/view-batch-fund-transfer-order-status			1000 calls per minute

Mecorp Plan

6000 calls per day

Select

Mecorp Plan

Bill Payment 1.0.6
Get list services of suppliers 1.0.4
Inquiry List of Suppliers 1.0.4
Retrieve Bill information 1.0.5

View details

APIs

Title	Version	Type	Rate limits
Bill Payment	1.0.6	REST	6000 calls per day
POST /payment/billPayment			6000 calls per day
Get list services of suppliers	1.0.4	REST	6000 calls per day
POST /payment/selectPartnerServiceCode			6000 calls per day
Inquiry List of Suppliers	1.0.4	REST	6000 calls per day
POST /payment/selectPartnerProviderCode			6000 calls per day
Retrieve Bill information	1.0.5	REST	6000 calls per day
POST /payment/retrievePartnerBill			6000 calls per day

Economic Plan

2 rate limits *

Select

Fintech Payment Services Plan - Economic

Bill Payment 1.0.6
Get list services of suppliers 1.0.4
Inquiry List of Suppliers 1.0.4
Retrieve Bill information 1.0.5

View details

Economic Plan

Fintech Payment Services Plan - Economic

APIs

Title	Version	Type	Rate limits
Bill Payment	1.0.6	REST	2 rate limits *
POST /payment/billPayment			2 rate limits *
Get list services of suppliers	1.0.4	REST	2 rate limits *
POST /payment/selectPartnerServiceCode			2 rate limits *
Inquiry List of Suppliers	1.0.4	REST	2 rate limits *
POST /payment/selectPartnerProviderCode			2 rate limits *
Retrieve Bill information	1.0.5	REST	2 rate limits *
POST /payment/retrievePartnerBill			2 rate limits *

Premier Plan

2 rate limits *

Select

Fintech Payment Services Plan – Premier

Bill Payment 1.0.6
Get list services of suppliers 1.0.4
Inquiry List of Suppliers 1.0.4
Retrieve Bill information 1.0.5

View details

Premier Plan

Fintech Payment Services Plan – Premier

APIs

Title	Version	Type	Rate limits
Bill Payment	1.0.6	REST	2 rate limits *
POST /payment/billPayment			2 rate limits *
Get list services of suppliers	1.0.4	REST	2 rate limits *
POST /payment/selectPartnerServiceCode			2 rate limits *
Inquiry List of Suppliers	1.0.4	REST	2 rate limits *
POST /payment/selectPartnerProviderCode			2 rate limits *
Retrieve Bill information	1.0.5	REST	2 rate limits *
POST /payment/retrievePartnerBill			2 rate limits *

Ultimate Plan

2 rate limits *

Select

Fintech Payment Services Plan – Ultimate

Bill Payment 1.0.6
Get list services of suppliers 1.0.4
Inquiry List of Suppliers 1.0.4
Retrieve Bill information 1.0.5

View details

Ultimate Plan

Fintech Payment Services Plan – Ultimate

APIs

Title	Version	Type	Rate limits
Bill Payment	1.0.6	REST	2 rate limits *
POST /payment/billPayment			2 rate limits *
Get list services of suppliers	1.0.4	REST	2 rate limits *
POST /payment/selectPartnerServiceCode			2 rate limits *
Inquiry List of Suppliers	1.0.4	REST	2 rate limits *
POST /payment/selectPartnerProviderCode			2 rate limits *
Retrieve Bill information	1.0.5	REST	2 rate limits *
POST /payment/retrievePartnerBill			2 rate limits *

ERP LINK Transfer Plan

2 rate limits *

Select

ERP LINK Transfer Plan

Check Transfer Status (Approved on OMNI Corp) 1.0.4
Create Domestic Transfer Order (Approving on OMNI Corporate) 1.0.3
Create Fast Transfer Order (Approving on OMNI Corporate) 1.0.3
Create Internal Transfer Order (Approving on OMNI Corporate) 1.0.3

View details

ERP LINK Transfer Plan

APIs

Title	Version	Type	Rate limits
Check Transfer Status (Approved on OMNI Corp)	1.0.4	REST	2 rate limits *
POST /payment/check-transfer-status-on-omni			2 rate limits *
Create Domestic Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	2 rate limits *
POST /payment/create-domestic-transfer-order			2 rate limits *
Create Fast Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	2 rate limits *
POST /oimt/create-fast-transfer-order			2 rate limits *
Create Internal Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	2 rate limits *
POST /payment/create-internal-transfer-order			2 rate limits *

UEH

2 rate limits *

Select

UEH

7 APIs including

Check Transfer Status (Approved on OMNI Corp) 1.0.4
Create Transfer Order (Approving on OMNI Corporate) 1.0.3
Get Payment Order (Approved on OMNI Corp) 1.0.2
Create Batch Collection Order (Approving on Omni Corporate) 1.0.4
Create Batch Transfer Order (Approving on Omni Corporate) 1.0.3

View details

APIs

Title	Version	Type	Rate limits
Check Transfer Status (Approved on OMNI Corp)	1.0.4	REST	2 rate limits *
POST /payment/check-transfer-status-on-omni			2 rate limits *
Create Transfer Order (Approving on OMNI Corporate)	1.0.3	REST	2 rate limits *
POST /payment/create-transfer-order			2 rate limits *
Get Payment Order (Approved on OMNI Corp)	1.0.2	REST	2 rate limits *
POST /payment/get-payment-order			2 rate limits *
Create Batch Collection Order (Approving on Omni Corporate)	1.0.4	REST	2 rate limits *
POST /payment/create-batch-collection-order			2 rate limits *
Create Batch Transfer Order (Approving on Omni Corporate)	1.0.3	REST	2 rate limits *
POST /payment/create-batch-transfer-order-omni			2 rate limits *
View batch fund transfer order status (Approving on OMNI Corporate)	1.0.6	REST	2 rate limits *
POST /omni/view-batch-fund-transfer-order-status			2 rate limits *
Get Credit Advice (Batch Transfer order approved on Omni)	1.0.1	REST	2 rate limits *
POST /omni/get-credit-advice-on-omni			2 rate limits *