Dokumentasi API Docs - CBM (Corporate Billing Management) - Outbound

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	Date	Link to Document	Description
v1.0	31 Oktober 2022	This Pages	Baseline version.

Product Description

Product Overview

The Corporate Billing Management (CBM) API serves the purpose of managing a company's bills and enables third-party companies to integrate their systems with the billing management services provided. It is used to handle and organize corporate billing by making use of both loan and non-loan facilities provided by BRI. This API is employed whenever there are billing transactions conducted by third-party companies.

Endpoint

A. Disbursement

Endpoint Description

This endpoint is used for callback sent to the partner after disbursement.

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	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
ReferenceNumber	String	M	18	Referral number obtained when successfully creating an invoice to CBM (create invoice).
InvoiceType	String		2	Invoice type. This field contains AP (Account Payable) or AR (Account Receivable).
InvoiceForm	String		100	The name of the anchor/principal company that carries out transactions with partner companies.
InvoiceTo	String		100	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		25	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 : APfor Supply Chain Financing - Account Payable. AR for Supply Chain Financing - Account Receivable. DFfor Distributor Financing VF for Vendor Financing. ARK for Supply Chain Financing - Account Receivable Combination. ARP for Supply Chain Financing - Account Receivable Partnership.
Description	String		35	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" : null,
            "StatusCode" : "13",
            "StatusDesc" : "Settlement On Progress",
        }

Normal Response :

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

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success.
403	01		Unauthorize access, please check your header.
400	02		Failed.
500	99		General Error.

B. Settlement

Endpoint Description

This endpoint is used for callback sent to the partner after payment to 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	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	Length	Description
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 : APfor Supply Chain Financing - Account Payable. AR for Supply Chain Financing - Account Receivable. DFfor Distributor Financing VF for Vendor Financing. ARK for Supply Chain Financing - Account Receivable Combination. ARP for Supply Chain Financing - Account Receivable Partnership.
Description	text		Additional information explaining the use or purpose of invoice financing.
DisbursementCompletedDate	string	10	The date and time the invoice disbursement was successfully processed (Disbursement and Invoice Payment) in formatyyyy-MM-dd.
SettlementCompletedDate	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.

Request 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 - Settlement Success",
            }

Normal Response :

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

List of Error/Response Code

HTTP Status	Code	Status	Response Message
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

This endpoint is used for callback sent to the partner after payment has been made to the anchor/principal before the disbursement date.

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	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	Length	Description
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 : APfor Supply Chain Financing - Account Payable. AR for Supply Chain Financing - Account Receivable. DFfor Distributor Financing VF for Vendor Financing. ARK for Supply Chain Financing - Account Receivable Combination. 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
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

This endpoint is used for callback sent to the partner after payment to BRI before the settlement date.

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	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	Length	Description
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 : APfor Supply Chain Financing - Account Payable. AR for Supply Chain Financing - Account Receivable. DFfor Distributor Financing VF for Vendor Financing. ARK for Supply Chain Financing - Account Receivable Combination. 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	Response Message
200	00	Success.
403	01	Unauthorize access, please check your header.
400	02	Failed.
500	99	General Error.

E. Stop Supply

Endpoint Description

This endpoint is used for callback sent to the partner if the company status is "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	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	Length	Description
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 : APfor Supply Chain Financing - Account Payable. AR for Supply Chain Financing - Account Receivable. DFfor Distributor Financing VF for Vendor Financing. ARK for Supply Chain Financing - Account Receivable Combination. 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	Response Message
200	00	Success.
403	01	Unauthorize access, please check your header.
400	02	Failed.
500	99	General Error.

F. Open Supply

Endpoint Description

This endpoint is used for callback sent to the partner if the company status changes to "Active" from "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	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	Length	Description
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 : AP for Supply Chain Financing - Account Payable. AR for Supply Chain Financing - Account Receivable. DF for Distributor Financing VF for Vendor Financing. ARK for Supply Chain Financing - Account Receivable Combination. 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	Response Message
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

API Docs - CBM (Corporate Billing Management) - Outbound

API Information

Version Control

Product Description

Product Overview

Endpoint

A. Disbursement

Endpoint Description

General Information

Header Structure

Request Structure

Response Structure & Sample

Request and Response Payload Sample

List of Error/Response Code

B. Settlement

Endpoint Description

General Information

Header Structure

Request Structure

Request Structure & Sample

Request and Response Payload Sample

List of Error/Response Code

C. Invoice Payment

Endpoint Description

General Information

Header Structure

Request Structure

Response Structure & Sample

Request and Response Payload Sample

List of Error/Response Code

D. Facility Payment

Endpoint Description

General Information

Header Structure

Request Structure

Response Structure & Sample

Request and Response Payload Sample

List of Error/Response Code

E. Stop Supply

Endpoint Description

General Information

Header Structure

Request Structure

Response Structure & Sample

Request and Response Payload Sample

List of Error/Response Code

F. Open Supply

Endpoint Description

General Information

Header Structure

Request Structure

Response Structure & Sample

Request and Response Payload Sample

List of Error/Response Code

General Error BRIAPI

Response Code

How do you like to contact us?