API Docs - CBM (Corporate Billing Management) - Outbound

Buat API

API Information

Title

CBM

Version

v1.0

URL Sandbox

https://sandbox.partner.api.bri.co.id

URL Production

https://partner.api.bri.co.id

Version Control

Versi Document

Tanggal

Link Dokumen

Deskripsi

v1.0

31 Oktober 2022

Halaman ini

Baseline version.

Product Description

Product Overview

API Corporate Billing Management (CBM) berfungsi untuk mengelola tagihan perusahaan dan memungkinkan perusahaan pihak ketiga mengintegrasikan sistem mereka dengan layanan manajemen tagihan pada Corporate Billing Management (CBM). Ia digunakan untuk mengelola dan mengatur tagihan perusahaan untuk memanfaatkan fasilitas pinjaman dan non-pinjaman yang diberikan BRI. Penggunaan API ini dipakai setiap kali ada transaksi tagihan yang dilakukan oleh perusahaan pihak ketiga.

Service Callback (Outbound) adalah layanan pengiriman informasi dari CBM ke Partner melalui service yang disediakan oleh Partner sesuai spesifikasi yang diberikan oleh CBM. Layanan tersebut bersifat opsional dan informasi yang diberikan meliputi event-event sebagai berikut :

  1. Disbursement
  2. Settlement
  3. Invoice Payment
  4. Facility Payment
  5. Stop Supply
  6. Open Supply

Endpoint

A. Disbursement

Endpoint Description

Endpoint ini digunakan untuk callback yang dikirim ke partner setelah pencairan.

General Information

HTTP Method

POST

Path

https://sandbox.partner.api.bri.co.id/apicbm/outbound/disbursement

Type Format

JSON

Authentication

Basic Authentication

Header Structure

Key

Value

Format

Mandatory

Length

Deskripsi

Content-Type

application/json

Alpha

M

 

application/json

CBM-Timestamp

CBM - Timestamp

Datetime

M

 

Waktu saat melakukan request ke endpoint

CBM-Signature

CBM - Signature

Alphanumeric

M

 

Signature request yang di-generate menggunakan algoritma HMAC-SHA256

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

ReferenceNumber

String

M

18

Nomor referral yang didapatkan ketika berhasil membuat invoice ke CBM (create invoice).

 

InvoiceType

String

 

2

Tipe invoice. Field ini berisi AP (Account Payable) atau AR (Account Receivable).

 

InvoiceForm

String

 

100

Nama perusahaan anchor/prinsipal yang melakukan transaksi dengan perusahaan partner.

 

InvoiceTo

String

 

100

Nama perusahaan partner yang melakukan dengan perusahaan anchor/prinsipal.

 

AnchorCode

String

 

20

Kode perusahaan anchor/prinsipal yang melakukan transaksi dengan perusahaan partner.

 

PartnerCode

String

 

20

Kode perusahaan partner yang melakukan dengan perusahaan anchor/prinsipal.

 

InvoiceNumber

String

 

25

Nomor invoice yang diterbitkan oleh perusahaan penerbit invoice.

 

Currency

String

 

3

Kode mata uang yang digunakan dalam transaksi invoice(IDR).

 

Amount

Numeric String

 

 

Nominal rupiah invoice yang akan dicairkan.

 

PaymentMethod

String

 

3

Metode pembayaran fasilitas yang digunakan atas pembiayaan invoice. Field ini dapat berisi salah satu dari :

 

  1. AP untuk Supply Chain Financing - Account Payable.
  2. AR untuk Supply Chain Financing - Account Receivable.
  3. DF untuk Distributor Financing
  4. VF untuk Vendor Financing.
  5. ARK untuk Supply Chain Financing - Account Receivable Kombinasi.
  6. ARP untuk Supply Chain Financing - Account Receivable Partnership.

 

Description

String

 

35

Keterangan tambahan yang menjelaskan penggunaan atau tujuan pembiayaan invoice.

 

DisbursementCompleteDate

String

 

10

Tanggal dan waktu pencairan invoice berhasil diproses (Disbursement dan Invoice Payment) dalam format yyyy-MM-dd.

 

SettlementCompleteDate

String

 

10

Tanggal dan waktu pelunasan fasilitas pinjaman atas invoiceberhasil yang telah dicairkan (Settlement dan Facility Payment) dalam format yyyy-MM-dd.

 

StatusCode

String

 

2

Kode status invoice yang diproses di CBM.

 

StatusDesc

String

 

25

Deskripsi status invoice yang diproses di CBM.

 

Response Structure & Sample

Field

Data Type

Mandatory

Length

Description

Example

ResponseCode

String

 

2

Kode respon dari client untuk callback disbursement.

 

ResponseDesc

String

 

100

Deskripsi respon dari client untuk callback disbursement.

 

ResponseData

Array

 

 

 

  

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber" : "DF0001023000829503",
            "InvoiceType" : "AR",
            "InvoiceFrom" : "Segar Food",
            "InvoiceTo" : "Menara Peninsula",
            "AnchorCode" : "CCEP",
            "PartnerCode" : "CPART1",
            "InvoiceNumber" : "PENIN-0623-STK",
            "Currency" : "IDR"
            "Amount" : "325000000",
            "PaymentMethod" : "DF",
            "Description" : "Tagihan Pengadaan Juni",
            "DisbursementCompletedDate" : "2023-06-05",
            "SettlementCompletedDate" : null,
            "StatusCode" : "13",
            "StatusDesc" : "Settlement On Progress",
        }

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Success.”
        }

List of Error/Response Code

HTTP Status

Code

Status

Response Message

Description

200

00

Success

Inquiry Success.

 

403

01

 

Unauthorize access, please check your header.

 

400

02

 

Failed.

 

500

99

 

General Error.

  

B. Settlement

Endpoint Description

Endpoint ini digunakan untuk callback yang dikirim ke partner setelah pelunasan ke BRI.

General Information

HTTP Method

POST

Path

https://sandbox.partner.api.bri.co.id/apicbm/outbound/settlement

Type Format

JSON

Authentication

Basic Authentication

Header Structure

Key

Value

Format

Mandatory

Length

Description

Content-Type

application/json

Alpha

M

 

application/json

CBM-Timestamp

CBM - Timestamp

Datetime

M

 

Time when making a request to the endpoint

CBM-Signature

CBM - Signature

Alphanumeric

M

 

Signature requests are generated using algorithm HMAC-SHA256

PartnerURL

URL Callback Partner

String

M

 

Target partner URL used to receive callback

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

ReferenceNumber

string

 

19

Nomor referral yang didapatkan ketika berhasil membuat invoice ke CBM (create invoice).

 

InvoiceType

string

 

3

Tipe invoice. Field ini berisi AP (Account Payable) atau AR (Account Receivable).

 

InvoiceFrom

string

 

50

Nama perusahaan anchor/prinsipal yang melakukan transaksi dengan perusahaan partner.

 

InvoiceTo

string

 

50

Nama perusahaan partner yang melakukan dengan perusahaan anchor/prinsipal.

 

AnchorCode

string

 

20

Kode perusahaan anchor/prinsipal yang melakukan transaksi dengan perusahaan partner.

 

PartnerCode

string

 

20

Kode perusahaan partner yang melakukan dengan perusahaan anchor/prinsipal.

 

InvoiceNumber

string

 

50

Nomor invoiceyang dikirimkan oleh perusahaan penerbit/penerima invoice.

 

Currency

string

 

3

Kode mata uang yang digunakan dalam transaksi invoice(IDR).

 

Amount

numeric string

 

 

Nominal rupiah invoice yang akan dicairkan.

 

PaymentMethod

string

 

3

Metode pembayaran yang digunakan untuk pembiayaan invoice. Field ini dapat berisi salah satu dari:

 

  1. AP untuk Supply Chain Financing - Account Payable.
  2. AR untuk Supply Chain Financing - Account Receivable.
  3. DF untuk Distributor Financing
  4. VF untuk Vendor Financing.
  5. ARK untuk Supply Chain Financing - Account Receivable Kombinasi.
  6. ARP untuk Supply Chain Financing - Account Receivable Partnership.

 

Description

text

 

 

Keterangan tambahan yang menjelaskan penggunaan atau tujuan pembiayaan invoice.

 

DisbursementCompletedDate

string

 

10

Tanggal dan waktu pencairan invoice berhasil diproses (Disbursement dan Invoice Payment) dalam format yyyy-MM-dd.

 

SettlementCompletedDate

string

 

10

Tanggal dan waktu pelunasan fasilitas pinjaman atas invoiceberhasil yang telah dicairkan (Settlement dan Facility Payment) dalam format yyyy-MM-dd.

 

StatusCode

string

 

2

Kode status invoice yang diproses di CBM.

 

StatusDesc

string

 

50

Deskripsi status invoice yang diproses di CBM.

 

Request Structure & Sample

Field

Data Type

Mandatory

Length

Description

Example

ResponseCode

string

 

2

Kode respon dari client untuk callback disbursement.

 

ResponseDesc

string

 

100

Deskripsi respon dari client untuk callback disbursement.

 

ResponseData

array

 

 

 

  

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber" : "DF0001023000829503",
            "InvoiceType" : "AR",
            "InvoiceFrom" : "Segar Food",
            "InvoiceTo" : "Menara Peninsula",
            "AnchorCode" : "CCEP",
            "PartnerCode" : "CPART1",
            "InvoiceNumber" : "PENIN-0623-STK",
            "Currency" : "IDR",
            "Amount" : "325000000",
            "PaymentMethod" : "DF",
            "Description" : "Tagihan Pengadaan Juni",
            "DisbursementCompletedDate" : "2023-06-05",
            "SettlementCompletedDate" : “2023-07-05”,
            "StatusCode" : "13",
            "StatusDesc" : "Completed - Settlement Success",
            }

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Success.”
        }

List of Error/Response Code

HTTP Status

Code

Status

Response Message

Description

200

00

Success

Inquiry Success

 

403

01

 

Unauthorize access, please check your header

 

403

02

 

Failed

 

500

99

 

General Error

  

C. Invoice Payment

Endpoint Description

Endpoint ini digunakan untuk callback yang dikirim ke partner setelah ada pembayaran ke anchor/principal sebelum tanggal disbursement.

General Information

HTTP Method

Get

Path

https://sandbox.partner.api.bri.co.id/apicbm/outbound/invoice-payment

Type Format

JSON

Authentication

Basic Authentication

Header Structure

Key

Value

Format

Mandatory

Length

Description

Content-Type

application/json

Alpha

M

 

application/json

CBM-Timestamp

CBM - Timestamp

Datetime

M

 

Time when making a request to the endpoint

CBM-Signature

CBM - Signature

Alphanumeric

M

 

Signature requests are generated using algorithm HMAC-SHA256

PartnerURL

URL Callback Partner

String

M

 

Target partner URL used to receive callback

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

ReferenceNumber

string

 

19

Referral number obtained when successfully creating an invoice to CBM (create invoice).

 

InvoiceType

string

 

3

Invoice type. This field contains AP (Account Payable) or AR (Account Receivable).

 

InvoiceFrom

string

 

50

The name of the anchor/principal company that carries out transactions with partner companies.

 

InvoiceTo

string

 

50

Name of the partner company that collaborates with the anchor/principal company.

 

AnchorCode

string

 

20

The code of the anchor/principal company that carries out transactions with partner companies.

 

PartnerCode

string

 

20

Code of the partner company that collaborates with the anchor/principal company.

 

InvoiceNumber

string

 

50

Invoice number issued by the invoice issuing company.

 

Currency

string

 

3

Currency code used in invoice transactions (IDR).

 

Amount

numeric string

 

 

Nominal Rupiah invoice to be disbursed.

 

PaymentMethod

string

 

3

Facility payment method used for invoice financing. This field can contain:

 

  1. APfor Supply Chain Financing - Account Payable.
  2. AR for Supply Chain Financing - Account Receivable.
  3. DFfor Distributor Financing
  4. VF for Vendor Financing.
  5. ARK for Supply Chain Financing - Account Receivable Combination.
  6. ARP for Supply Chain Financing - Account Receivable Partnership.

 

Description

text

 

 

Additional information explaining the use or purpose of invoice financing.

 

DisbursementCompleteDate

string

 

10

The date and time the invoice disbursement was successfully processed (Disbursement and Invoice Payment) in formatyyyy-MM-dd.

 

SettlementCompleteDate

string

 

10

Date and time of repayment of loan facilities on successful invoices that have been disbursed (Settlement and Facility Payment) in formatyyyy-MM-dd.

 

StatusCode

string

 

2

Invoice status code. List of code can be found in the INVOICE STATUS DETAILsection of this document.

 

StatusDesc

string

 

50

Description of the invoice status processed in CBM.

 

Response Structure & Sample

Field

Data Type

Mandatory

Length

Description

Example

ResponseCode

string

 

2

Response code from the partner for the disbursement callback.

 

ResponseDesc

string

 

100

Description of the response from the partner for the disbursement callback.

  

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber" : "DF0001023000829503",
            "InvoiceType" : "AR",
            "InvoiceFrom" : "Segar Food",
            "InvoiceTo" : "Menara Peninsula",
            "AnchorCode" : "CCEP",
            "PartnerCode" : "CPART1",
            "InvoiceNumber" : "PENIN-0623-STK",
            "Currency" : "IDR",
            "Amount" : "325000000",
            "PaymentMethod" : "DF",
            "Description" : "Tagihan Pengadaan Juni",
            "DisbursementCompletedDate" : "2023-06-04",
            "SettlementCompletedDate" : “2023-06-04”,
            "StatusCode" : "13",
            "StatusDesc" : "Completed - Invoice Payment"
        }

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Success.”
        }

List of Error/Response Code

HTTP Status

Code

Status

Response Message

Description

200

00

Success

Inquiry Success

 

403

01

 

Unauthorize access, please check your header

 

403

02

 

Failed

 

500

99

 

General Error

  

D. Facility Payment

Endpoint Description

Endpoint ini digunakan untuk callback yang dikirim ke partner setelah ada pembayaran ke BRI sebelum tangal settlement.

General Information

HTTP Method

POST

Path

https://sandbox.partner.api.bri.co.id/apicbm/outbound/facility-payment

Type Format

JSON

Authentication

Basic Authentication

Header Structure

Key

Value

Format

Mandatory

Length

Description

Content-Type

application/json

Alpha

M

 

application/json

CBM-Timestamp

CBM - Timestamp

Datetime

M

 

Time when making a request to the endpoint

CBM-Signature

CBM - Signature

Alphanumeric

M

 

Signature requests are generated using algorithm HMAC-SHA256

PartnerURL

URL Callback Partner

String

M

 

Target partner URL used to receive callback

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

ReferenceNumber

string

 

19

Referral number obtained when successfully creating an invoice to CBM (create invoice).

 

InvoiceType

string

 

3

Invoice type. This field contains AP (Account Payable) or AR (Account Receivable).

 

InvoiceFrom

string

 

50

The name of the anchor/principal company that carries out transactions with partner companies.

 

InvoiceTo

string

 

50

Name of the partner company that collaborates with the anchor/principal company.

 

AnchorCode

string

 

20

The code of the anchor/principal company that carries out transactions with partner companies.

 

PartnerCode

string

 

20

Code of the partner company that collaborates with the anchor/principal company.

 

InvoiceNumber

string

 

50

Invoice number issued by the invoice issuing company.

 

Currency

string

 

3

Currency code used in invoice transactions (IDR).

 

Amount

numeric string

 

 

Nominal Rupiah invoice to be disbursed.

 

PaymentMethod

string

 

3

Facility payment method used for invoice financing. This field can contain:

 

  1. APfor Supply Chain Financing - Account Payable.
  2. AR for Supply Chain Financing - Account Receivable.
  3. DFfor Distributor Financing
  4. VF for Vendor Financing.
  5. ARK for Supply Chain Financing - Account Receivable Combination.
  6. ARP for Supply Chain Financing - Account Receivable Partnership.

 

Description

text

 

 

Additional information explaining the use or purpose of invoice financing.

 

DisbursementCompleteDate

string

 

10

The date and time the invoice disbursement was successfully processed (Disbursement and Invoice Payment) in formatyyyy-MM-dd.

 

SettlementCompleteDate

string

 

10

Date and time of repayment of loan facilities on successful invoices that have been disbursed (Settlement and Facility Payment) in formatyyyy-MM-dd.

 

StatusCode

string

 

2

Invoice status code processed in CBM.

 

StatusDesc

string

 

50

Description of the invoice status processed in CBM.

 

Response Structure & Sample

Field

Data Type

Mandatory

Length

Description

Example

ResponseCode

string

 

2

Response code from the partner for the disbursement callback.

 

ResponseDesc

string

 

100

Description of the response from the partner for the disbursement callback.

  

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber" : "DF0001023000829503",
            "InvoiceType" : "AR",
            "InvoiceFrom" : "Segar Food",
            "InvoiceTo" : "Menara Peninsula",
            "AnchorCode" : "CCEP",
            "PartnerCode" : "CPART1",
            "InvoiceNumber" : "PENIN-0623-STK",
            "Currency" : "IDR",
            "Amount" : "325000000",
            "PaymentMethod" : "DF",
            "Description" : "Tagihan Pengadaan Juni",
            "DisbursementCompletedDate" : "2023-06-05",
            "SettlementCompletedDate" : “2023-07-05”,
            "StatusCode" : "13",
            "StatusDesc" : "Completed - Facility Payment"
        }

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Success.”
        }

List of Error/Response Code

HTTP Status

 Code

Status

Response Message

Description

200

00

 

Success.

 

403

01

 

Unauthorize access, please check your header.

 

400

02

 

Failed.

 

500

99

 

General Error.

  

E. Stop Supply

Endpoint Description

Endpoint ini digunakan untuk service callback yang dikirim ke partner jika status company adalah "Default".

General Information

HTTP Method

POST

Path

https://sandbox.partner.api.bri.co.id/apicbm/outbound/stop-supply

Type Format

JSON

Authentication

Basic Authentication

Header Structure

Key

Value

Format

Mandatory

Length

Description

Content-Type

application/json

Alpha

M

 

application/json

CBM-Timestamp

CBM - Timestamp

Datetime

M

 

Time when making a request to the endpoint

CBM-Signature

CBM - Signature

Alphanumeric

M

 

Signature requests are generated using algorithm HMAC-SHA256

PartnerURL

URL Callback Partner

String

M

 

Target partner URL used to receive callback

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

AnchorCode

string

 

20

The code of the anchor/principal company that carries out transactions with partner companies.

 

PartnerCode

string

 

20

Code of the partner company that collaborates with the anchor/principal company.

 

PaymentMethod

string

 

3

Facility payment method used for invoice financing. This field can contain :

 

  1. APfor Supply Chain Financing - Account Payable.
  2. AR for Supply Chain Financing - Account Receivable.
  3. DFfor Distributor Financing
  4. VF for Vendor Financing.
  5. ARK for Supply Chain Financing - Account Receivable Combination.
  6. ARP for Supply Chain Financing - Account Receivable Partnership.

 

FacilityStatus

string

 

2

Code status facility in CBM.

 

FacilityStatusDesc

string

 

50

Description status facility in CBM.

 

Response Structure & Sample

Field

Data Type

Mandatory

Length

Description

Example

ResponseCode

string

 

2

Response code from the partner for the disbursement callback.

 

ResponseDesc

string

 

100

Description of the response from the partner for the disbursement callback.

  

Request and Response Payload Sample

Request :

        {
            "AnchorCode" : "CCEP",
            "PartnerCode" : "CPART1",
            "PaymentMethod" : "DF",
            "FacilityStatus" : "01",
            "FacilityStatusDesc" : "Default"
        }

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Success.”
        }

List of Error/Response Code

HTTP Status

 Code

Status

Response Message

Description

200

00

 

Success.

 

403

01

 

Unauthorize access, please check your header.

 

400

02

 

Failed.

 

500

99

 

General Error.

  

F. Open Supply

Endpoint Description

Endpoint ini digunakan untuk service callback yang dikirim ke partner jika status company berubah menjadi "Active" dari "Default".

General Information

HTTP Method

POST

Path

https://sandbox.partner.api.bri.co.id/apicbm/outbound/open-supply

Type Format

JSON

Authentication

Basic Authentication

Header Structure

Key

Value

Format

Mandatory

Length

Description

Content-Type

application/json

Alpha

M

 

application/json

CBM-Timestamp

CBM - Timestamp

Datetime

M

 

Time when making a request to the endpoint

CBM-Signature

CBM - Signature

Alphanumeric

M

 

Signature requests are generated using algorithm HMAC-SHA256

PartnerURL

URL Callback Partner

String

M

 

Target partner URL used to receive callback

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

AnchorCode

string

 

20

The code of the anchor/principal company that carries out transactions with partner companies.

 

PartnerCode

string

 

20

Code of the partner company that collaborates with the anchor/principal company.

 

PaymentMethod

string

 

3

Facility payment method used for invoice financing. This field can contain :

 

  1. APfor Supply Chain Financing - Account Payable.
  2. .AR for Supply Chain Financing - Account Receivable.
  3. DFfor Distributor Financing
  4. VF for Vendor Financing.
  5. ARK for Supply Chain Financing - Account Receivable Combination.
  6. ARP for Supply Chain Financing - Account Receivable Partnership.

 

FacilityStatus

string

 

2

Code status facility in CBM.

 

FacilityStatusDesc

string

 

50

Description status facility in CBM.

 

Response Structure & Sample

Field

Data Type

Mandatory

Length

Description

Example

ResponseCode

string

 

2

Response code from the partner for the disbursement callback.

 

ResponseDesc

string

 

100

Description of the response from the partner for the disbursement callback.

  

Request and Response Payload Sample

Request :

        {
            "AnchorCode" : "CCEP",
            "PartnerCode" : "CPART1",
            "PaymentMethod" : "DF",
            "FacilityStatus" : "00",
            "FacilityStatusDesc" : "Active"
        }

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Success.”
        }

List of Error/Response Code

HTTP Status

Code

Status

Response Message

Description

200

00

 

Success.

 

403

01

 

Unauthorize access, please check your header.

 

400

02

 

Failed.

 

500

99

 

General Error.

 

General Error BRIAPI

Response Code

This is a general response code that will appear for products from BRIAPI.

HTTP Status

Response Code

Response Message

Description

400

0109

Invalid Request Parameter

Error in validating request data

401

0601

Invalid Authentication

Error in authentication

500

0500

General Error

Unexpected problem

503

0503

Service Unavailable

Error when accessing the product being used

504

0504

Gateway Timeout

Connection timeout