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

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

Document Version	Date	Link to Document	Description
v1.0	14 Juli 2022	this page	Baseline version.
v1.1	30 Oktober 2022	this page	Update data endpoint
v1.1	31 Oktober 2023	this page	Update data endpoint
v1.1	27 Agustus 2024	this page	· Update endpoint Create Invoice · Additional endpoint Instapay, Facility Payment, and Enable Settlement

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. Get Token

Endpoint Description

This endpoint is used to obtain an access token which functions as an authentication when you want to access the API. The pilot test checks that the get token is not hit every time you access the endpoint (integrator).

General Information

HTTP Method	POST
Path	/oauth/client_credential/accesstoken?grant_type=client_credentials
Tipe Format	form-urlencoded
Authentication	Digital Signature

Key	Value	Mandatory
Content-Type	application/x-www-urlencoded	M

Request Structure

Field	Data Type	Format	Mandatory	Length	Description	Example
client_id	string	Alphanumeric	M		Consumer key
client_secret	string	Alphanumeric	M		Consumer secret

Request and Response Payload Sample

Request :

        --location --request POST 'https://partner.api.bri.co.id/oauth/client_credential/accesstoken?grant_type=client_credentials' \
        --header 'Content-Type: application/x-www-form-urlencoded' \
        --data-urlencode 'client_id={{id_key}}' \
        --data-urlencode 'client_secret={{secret_key}}'

Normal Response :

        {
            "refresh_token_expires_in": "0",
            "api_product_list": "[inquiry-sandbox]",
            "api_product_list_json": [
                "inquiry-sandbox"
            ],
            "organization_name": "bri",
            "developer.email": "Dummi@co.id",
            "token_type": "BearerToken",
            "issued_at": "1698720075001",
            "client_id": "l9sDPeHCgTFbwsol7rvpX8jkhgbamueg",
            "access_token": "zBF6GNuzXZ7eRvdiWjkljioutpcm",
            "application_name": "6a65abd2-6c38-4619-b00e-dd1044c6b843",
            "scope": "",
            "expires_in": "179999",
            "refresh_count": "0",
            "status": "approved"
        }

B. Inquiry Invoice By Reference Number

Endpoint Description

This endpoint is used to do an inquiry (check) on the invoice status using the invoice ReferenceNumber. The invoice reference number is a unique code that links each invoice issued by the partner to the CBM application. The invoice reference number is obtained from response data from the create invoice endpoint in the CBM API. Make sure to always save this reference number after successful creation of the invoice.

General Information

HTTP Method	GET
Path	/v1/apicbm/invoices/(referenceNumber}
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

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.
InvoiceNumber	string	50	Invoice number issued by the invoice issuing company.
InvoiceDate	date	10	Date of issue of invoice by partner in yyyy-MM-dd format.
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. AP for Supply Chain Financing - Account Payable. 2. AR for Supply Chain Financing - Account Receivable. 3. DF for 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.
DisbursementDate	date	10	Date (schedule) of disbursement of loan facilities on invoices in the format yyyy-MM-dd.
DisbursementCompletedDate	timestamp		The date and time the invoice disbursement was successfully processed (Disbursement and Invoice Payment) in format yyyy-MM-dd hh:mm:ss.
SettlementDate	date		The invoice settlement date (schedule) is in the format yyyy-MM-dd.
SettlementCompletedDate	timestamp		Date and time of repayment of loan facilities on successful invoices that have been disbursed (Settlement and Facility Payment) in format yyyy-MM-dd hh:mm:ss.
CreatedDate	timestamp		Date and time for facility financing on an invoice in the format yyyy-MM-dd hh:mm:ss.
StatusCode	string	2	Invoice status code. List of code can be found in the INVOICE STATUS DETAIL section of this document.
StatusDesc	text		Description of the invoice status processed in CBM.

Request and Response Payload Sample

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Inquiry Success.",
            "responseData": {
            "ReferenceNumber": "DF0002323000006880",
            "InvoiceType": "INV AR",
            "InvoiceFrom": "BRIAPI 01",
            "InvoiceTo": "BRIAPI 02",
            "InvoiceNumber": "SB-20231019-001",
            "InvoiceDate": "2023-10-19",
            "Currency": "IDR",
            "Amount": "10.00",
            "PaymentMethod": "DF",
            "Description": "Invoice pembelian barang",
            "DisbursementDate": "2023-10-19",
            "DisbursementCompleteDate": null,
            "SettlementDate": "2023-10-22",
            "SettlementCompleteDate": null,
            "CreateDate": "2023-10-19 12:30:33",
            "StatusCode": "10",
            "StatusDesc": "Disbursement On Progress"
            }
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success.
403	10		Unauthorize Access.
403	11		CBM-CorporateRequestId cannot duplicate.
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
500	99		General Error.

C. Inquiry Invoice By Invoice Number

Endpoint Description

This endpoint is used to conduct inquiries (checks) on invoice status using the invoice number, anchor code and partner code. The invoice number is from the transaction entered into CBM at the create invoice endpoint. This invoice number is created by the partner and is unique for each relationship between anchors and partners in CBM. Make sure to always save this invoice number after successful invoice creation as an alternative to inquiry invoices other than inquiry by reference number.

General Information

HTTP Method	GET
Path	v1/apicbm/inquiryInvoices/inquiry_by_invoicenumber?invoice_number={InvoiceNumber}&anchor_code={AnchorCode}&partner_code={PartnerCode}
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

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.
InvoiceNumber	string	50	Invoice number issued by the invoice issuing company.
InvoiceDate	date	10	Date of issue of invoice by partner in yyyy-MM-dd format.
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. AP for Supply Chain Financing - Account Payable. 2. AR for Supply Chain Financing - Account Receivable. 3. DF for 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.
DisbursementDate	date	10	Date (schedule) of disbursement of loan facilities on invoices in the format yyyy-MM-dd.
DisbursementCompletedDate	timestamp		The date and time the invoice disbursement was successfully processed (Disbursement and Invoice Payment) in format yyyy-MM-dd hh:mm:ss.
SettlementDate	date		The invoice settlement date (schedule) is in the format yyyy-MM-dd.
SettlementCompletedDate	timestamp		Date and time of repayment of loan facilities on successful invoices that have been disbursed (Settlement and Facility Payment) in format yyyy-MM-dd hh:mm:ss.
CreatedDate	timestamp		Date and time for facility financing on an invoice in the format yyyy-MM-dd hh:mm:ss.
StatusCode	string	2	Invoice status code. List of code can be found in the INVOICE STATUS DETAIL section of this document.
StatusDesc	text		Description of the invoice status processed in CBM.

Request and Response Payload Sample

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Inquiry Success.",
            "responseData": {
            "ReferenceNumber": "DF0002323000006880",
            "InvoiceType": "INV AR",
            "InvoiceFrom": "BRIAPI 01",
            "InvoiceTo": "BRIAPI 02",
            "InvoiceNumber": "SB-20231019-001",
            "InvoiceDate": "2023-10-19",
            "Currency": "IDR",
            "Amount": "10.00",
            "PaymentMethod": "DF",
            "Description": "Invoice pembelian barang",
            "DisbursementDate": "2023-10-19",
            "DisbursementCompleteDate": null,
            "SettlementDate": "2023-10-22",
            "SettlementCompleteDate": null,
            "CreateDate": "2023-10-19 12:30:33",
            "StatusCode": "10",
            "StatusDesc": "Disbursement On Progress"
            }
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success.
403	10		Unauthorize Access.
403	11		CBM-CorporateRequestId cannot duplicate.
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
500	99		General Error

D. Create Invoice

Endpoint Description

This endpoint is used to make new invoices by the client. The response from this endpoint is in the form of an invoice ReferenceNumber. Make sure to always save this reference number after successfully creating an invoice in CBM. The reference number is used as a parameter on other endpoints (inquiry invoice, cancel invoice, payment invoice and facility invoice).

General Information

HTTP Method	POST
Path	/v1/apicbm/invoices/insert
Type Format	JSON
Authentication	OAuth 2.0

Key	Value	Format	Mandatory	Description
Accept	application/json
Content-type	application/json
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Request Structure

Field	Data Type	Mandatory	Length	Description	Example
AnchorCode	string	M	6	The code of the anchor/principal company that carries out transactions with partner companies.	PRTMN1
PartnerCode	string	M	20	Code of the partner company that collaborates with the anchor/principal company.	GRD1
InvoiceType	string	M	2	Invoice type. This field contains AP (Account Payable) or AR (Account Receivable).	AP
InvoiceDate	string	M	10	Date of issue of invoice in yyyy-MM-dd format.	2020-02-14
InvoiceNumber	string	M	30	Invoice number issued by the invoice issuing company.	DF/1/2034n
Currency	string	M	3	Currency code used in invoice transactions (IDR).	IDR
Amount	numeric	M		Nominal Rupiah invoice to be disbursed.	1210
DisbursementDate	string	M	10	Date (schedule) of disbursement of loan facilities on invoices in the format yyyy-MM-dd.	2020-03-10
SettlementDate	string	Yes: for all payment methods other than DF No: if the payment method is DF	10	The invoice settlement date (schedule) is in the format yyyy-MM-dd.	2020-04-10
SharingDate	string	Yes : if the payment method is VF No: for all payment methods other than VF	10	Date (schedule) of distribution of loan facility interest payments on invoices in the format yyyy-MM-dd.
Description	string	M	100	Additional information explaining the use or purpose of invoice financing.	Tes AP
PaymentMethod	string	M	2	Facility payment method used for invoice financing. This field can contain: 1. AP for Supply Chain Financing - Account Payable. 2. AR for Supply Chain Financing - Account Receivable. 3. DF for 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.	AP
BeneficaryAccount	string	O	15	Account number of the receiver of the facility disbursement. If the AnchorCode is the same as the PartnerCode and the PaymentMethod used is AP, then the BeneficiaryAccount is mandatory.
Attachment	string	Related with the company configuration		File encoded using base64 encoding with a maximum file size of 10 MB. Only accepts two file types: .pdf or .zip. If the attachment is a .zip file, all compressed content must be in .pdf format.

Response Structure & Sample

Field	Data Type	Mandatory	Length	Description	Example
ReferenceNumber	string		19	Referral number obtained when successfully creating an invoice to CBM (create invoice).	0000420000214
Message	text			Additional information for the invoices sent.

Request and Response Payload Sample

Request (AP) :

        {
            "AnchorCode": "BRIAPI01",
            "PartnerCode": "BRIAPI02",
            "InvoiceType": "AR",
            "InvoiceDate": "2023-10-01",
            "InvoiceNumber": "SB-20231001-001",
            "Currency": "IDR",
            "Amount": 1000,
            "DisbursementDate": "2023-10-01",
            "Description": "Invoice pembelian barang",
            "PaymentMethod": "DF"
           "Attachment":"JVBERi0xLjQgc2FtcGxlIFBERiBjb250ZW50Cg=="
        }

Request (AP Lepasan) :

        {
            "AnchorCode":"BRIAPI01",
            "PartnerCode":"BRIAPI01",
            "InvoiceType":"AP",
            "InvoiceDate":"2023-10-01",
            "InvoiceNumber":"AP/2023/10/01/001",
            "Currency":"IDR",
            "Amount":10.12,
            "DisbursementDate":"2023-10-01",
            "Description":"Invoice pembelian barang",
            "PaymentMethod":"AP",
            "BeneficiaryAccount":"020601123456500"
            "Attachment":"JVBERi0xLjQgc2FtcGxlIFBERiBjb250ZW50Cg=="
        }

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Create Invoices successful.",
            "responseData": {
            "ReferenceNumber": "0000420000214",
            "Message": "Invoice Number DF/1/2034l successful created"
            }
        }

Error Response :

        {
            "responseCode": "03",
            "responseDesc": "Action cannot be processed. invoice number DF/10/10 already exist",
            "responseData": null
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Create invoice successfully.
403	10		Unauthorize Access.
403	11		CBM-CorporateRequestId cannot duplicate.
400	01		Invalid data request.
400	02		Action cannot be processed.
400	03		Action cannot be processed.
400	04		Action cannot be proccessed. Proceed time is not allowed.
500	99		General Error.

E. Cancel Invoice

Endpoint Description

This endpoint is used to cancel invoices that have been sent, as long as there has been no disbursement of the invoice (maximum H-1 before the disbursement date). When requesting an invoice cancellation, the system will validate the match between the invoice reference number and the invoice number issued by the invoice issuing company.

General Information

HTTP Method	POST
Path	/v1/apicbm/invoices/cancel
Type Format	JSON
Authentication	OAuth 2.0

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Field	Data Type	Mandatory	Length	Description	Example
ReferenceNumber	string		19	Referral number obtained when successfully creating an invoice to CBM (create invoice).	0000420000221
InvoiceNumber	string		25	Invoice number issued by the invoice issuing company.	DF-FACPAYMENT-007

Field	Data Type	Mandatory	Length	Description	Example
ReferenceNumber	string		19	Referral number obtained when successfully creating an invoice to CBM (create invoice).	0000420000221
Message	text			Additional information on invoice cancellation.	Invoice Number DF-FACPAYMENT-007 cancelled

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber" : "VF0002123000037636",
            "InvoiceNumber"  : "SB-20230829-991",
        }

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Invoice Cancelation Success!",
            "responseData": {
            "ReferenceNumber": "VF0002123000037636",
            "Message": "Invoice Number SB-20230829-991 canceled"
            }
        }

Error Response :

        {
            "responseCode": "03",
            "responseDesc": "Action cannot be processed. Invoice status is: Canceled - Invoice Canceled",
            "responseData": null
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Cancel invoice success.
403	10		Unauthorize access.
403	11		CBM-CorporateRequestId cannot duplicate.
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
400	04		Action cannot be processed. Proceed time is not allowed.
500	99		General Error.

F. Payment Invoice

Endpoint Description

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

General Information

HTTP Method	POST
Path	/v1/apicbm/invoices/payment
Type Format	JSON
Authentication	OAuth 2.0

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Request Structure

Field	Data Type	Mandatory	Length	Description	Example
ReferenceNumber	string		19	Referral number obtained when successfully creating an invoice to CBM (create invoice).	0000420000213
InvoiceNumber	string		25	Invoice number issued by the invoice issuing company.	DF/1/2034k

Response Structure & Sample

Field	Data Type	Mandatory	Length	Description	Example
ReferenceNumber	string		19	Referral number obtained when successfully creating an invoice to CBM (create invoice).	0000420000213
Message	text			Additional information on the invoice sent.	Invoice Number DF/1/2034k paid

Request and Response Payload Sample

Request :

        { 
            "ReferenceNumber": "0001020000002", 
            "InvoiceNumber": "SB-20230829-991",
        }

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Invoice Payment successful.",
            "responseData": {
            "ReferenceNumber": "0001020000002",
            "Message": "Invoice Number J123/231/039 paid"
            }
        }

Error Response :

        {
            "responseCode": "03",
            "responseDesc": "Action cannot be processed. invoice payment not allowed, current status is cancel approved",
            "responseData": null
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Facility Payment successful.
403	10		Unauthorize access.
403	11		CBM-CorporateRequestId cannot duplicate.
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
400	04		Action cannot be processed. Proceed time is not allowed.
500	99		General Error.

G. Inquiry Corporate Facilities (My Facility)

Endpoint Description

This endpoint is used to obtain information on the list of facilities owned by the anchor company. The information that is displayed is the type of facility and account number between the principal and partner.

General Information

HTTP Method	GET
Path	/v1/apicbm/facilities/{AnchorCode}
Type Format	JSON
Authentication	OAuth 2.0

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

Field	Data Type	Length	Description
FacilityCode	string	2	Facility code owned by the entity.
FacilityCodeDesc	text		General description of the facility code, which can be the name of the facility itself.
FacilityAccount	string	15	Account number that has been linked to the facility.

Request and Response Payload Sample

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Inquiry Success",
            "responseData": [
            {
            "facilityCode": "AP",
            "facilityCodeDesc": "Account Payable",
            "facilityAccount": "020601008846309"
            },
            {
            "facilityCode": "AR",
            "facilityCodeDesc": "Account Receivable",
            "facilityAccount": "020601008846309"
            }
            ]
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success
403	10		Unauthorize access
403	11		CBM-CorporateRequestId can not duplicate
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
500	99		General Error

H. Inquiry Facility Balance

Endpoint Description

This endpoint is used to obtain detailed information about the facilities owned by the principal. The information that is displayed is the loan ceiling, withdrawal allowance and so on.

General Information

HTTP Method	GET
Path	/v1/apicbm/facilities/{AnchorCode}?facility_account={Account}
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_id and client_secret from the BRIAPI get token endpoint. Format: Bearer {access_token} Example: Bearer mAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format: yyyy-mm-ddThh:mm:ss.SSSZ Example: 2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format: {generated_signature} Example: vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format: Bearer {CBM Token} Example: Bearer 7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

Field	Data Type	Length	Description	Example
FacilityCode	string	2	Payment method code owned by the facility owner. Can be : 1. AP for Supply Chain Financing - Account Payable. 2. AR for Supply Chain Financing - Account Receivable. 3. ARK for Supply Chain Financing - Account Receivable Combination.	AP
FacilityStatus	string	2	The status code of a facility owned by a single entity. 1. 00 - Active 2. 01 -Default	00
FacilityStatusDesc	string	100	Details of the status of facilities owned by the entity
Facility	string	50	Name of the facility owned by the entity
FacilityAccount	string	15	Account number that has been linked to the facility
AccountName	string	50	Name of the owner of the account number
Plafond	numeric string		Maximum limit of the facility
Outstanding	numeric string		Nominal that has not been repaid (used) from a facility
AccountStatus	string	20	Description of the status of the facility owned by the entity
FacilityDueDate	timestamp		Due date for payment of the facility
AvailableAmount	numeric string		Remaining limit of the facility owned

Request and Response Payload Sample

Normal Response :

        {
            "responseCode" : "00",
            "responseDesc" : "Inquiry success",
            "responseData" : {
            "FacilityCode"    : "AP",
            "FacilityAccount"  : "020601008846309",
            "Facility"      : "SCF AP",
            "AccountName"    : "PENGEMBANGAN PRODUK",
            "Plafond"      : "1000000",
            "Outstanding"    : "160",
            "AccountStatus"   : "ACTIVE",
            "FacilityDueDate"  : "12/1/2023 12:00:00 AM",
            "AvailableAmount"  : "998690",
            "FacilityStatus"   : "00",
            "FacilityStatusDesc" : "Active"
            }
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success
403	10		Unauthorize access
403	11		CBM-CorporateRequestId cannot duplicate
400	01		Invalid data request. {Specific Desc}.
400	02		Action cannot be processed. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
500	99		General Error

I. Inquiry List Partner

Endpoint Description

This endpoint is used to obtain information on the list of partners who are related (cooperate) with one principal.

General Information

HTTP Method	GET
Path	/v1/apicbm/partners/{AnchorCode}
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_idand client_secretfrom the BRIAPI get token endpoint. Format:Bearer{access_token} Example:BearermAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format:yyyy-mm-ddThh:mm:ss.SSSZ Example:2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format:{generated_signature} Example:vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format:Bearer {CBM Token} Example:Bearer7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

Field	Data Type	Length	Description	Example
CompanyId	string	5	ID partner registered in CBM.	00
PartnerCode	string	20	Code of the partner company that collaborates with the anchor/principal company.
PartnerName	string	100	Name of the partner company that collaborates with the anchor/principal company.

Request and Response Payload Sample

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Inquiry Success.",
            "responseData": [
            {
            "PartnerCode": "00025",
            "InitialCode": "BRIAPI02",
            "PartnerName": "BRIAPI 02"
            }
            ]
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success
400	10		Unauthorize access
400	11		CBM-CorporateRequestId cannot duplicate
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
500	99		General Error

J. Inquiry Detail Partner by Partner Code

Endpoint Description

Endpoint used to inquire about partner status and what facilities are linked to Anchor.

General Information

HTTP Method	GET
Path	/v1/apicbm/partners/{AnchorCode}?partner_code={PartnerCode}
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_idand client_secretfrom the BRIAPI get token endpoint. Format:Bearer{access_token} Example:BearermAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format:yyyy-mm-ddThh:mm:ss.SSSZ Example:2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format:{generated_signature} Example:vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format:Bearer {CBM Token} Example:Bearer7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

Field	Data Type	Length	Description
PartnerCode	string	20	Code of the partner company that collaborates with the anchor/principal company.
PartnerName	string	100	Name 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.APforSupply Chain Financing - Account Payable. 2.ARforSupply Chain Financing - Account Receivable. 3.DFforDistributor Financing 4.VFforVendor Financing. 5.ARKforSupply Chain Financing - Account Receivable Combination. 6.ARPforSupply Chain Financing - Account Receivable Partnership.
PaymentMethodDesc	text		Description of payment method used.

Request and Response Payload Sample

Normal Response :

        {
            ResponseCode : “00”,
            ResponseDesc : “Inquiry Success”
            ResponseData : [
        {
            “PartnerCode”    : “Company1”,
            “PartnerName”    : “PT. Company Nusantara”,
            “PaymentMethod”   : “DF”,
            “PaymentMethodDesc” : “Distributor Financing”
        },
        {
            “PartnerCode”    : “Company1”,
            “PartnerName”    : “PT. Company Indonesia”,
            “PaymentMethod”   : “AR”,
            “PaymentMethodDesc” : “Account Receivable”
        }
        ]
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success
403	10		Unauthorize access
403	11		CBM-CorporateRequestId cannot duplicate
400	01		Invalid data request. {Specific Desc}.
400	03		Action cannot be processed. {Specific Desc}.
500	99		General Error

K. Inquiry Partner Facility by Partner Code and Payment Method

Endpoint Description

The endpoint is used to inquire about partner status (both facility information and overdue status) according to the payment method.

General Information

HTTP Method	GET
Path	/v1/apicbm/partners/{AnchorCode}?partner_code={PartnerCode}&facility_code={PaymentMethod}
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_idand client_secretfrom the BRIAPI get token endpoint. Format:Bearer{access_token} Example:BearermAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format:yyyy-mm-ddThh:mm:ss.SSSZ Example:2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format:{generated_signature} Example:vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format:Bearer {CBM Token} Example:Bearer7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Response Structure & Sample

Field	Data Type	Length	Description	Example
PartnerCode	string	20	Code of the partner company that collaborates with the anchor/principal company.	apr
PartnerName	string	100	Name of the partner company that collaborates with the anchor/principal company.	Angkasa Pura 1
FacilityCode	string	3	Payment method code that has been linked between two corporate entities, the anchor company (AnchorCode) and the partner company (PartnerCode). 1.DFfor Distributor Financing 2.VFfor Vendor Financing.	VF
AccountNumber	string	16	Number of the owner of the account number.
AccountName	string	255	Name of the owner of the account number.	TEST JUMAT
AccountStatus	string	20	Loan account status 1.Active 2.Mature but not close 3.Close	Active
LoanDueDate	date	10	Facility payment due date in yyyy-MM-ddformat.
Plafond	numeric string		Maximum limit of the facility.
Outstanding	numeric string		Nominal that has not been repaid (used) from a facility.
HoldAmount	numeric string		Nominal funds that are withheld.
AvailableAmount	numeric string		Remaining limit of the facility owned.
FacilityStatus	string	2	The status code of a facility owned by a single entity. 1.00-Active 2.01-Default
FacilityStatusDesc	text		Details of the status of facilities owned by the entity.
LastInvoiceDefault	string	19	Reference Number of Default Invoice (If Any)

Request and Response Payload Sample

Normal Response :

        {
            "responseCode": "00",
            "responseDesc": "Inquiry Success.",
            "responseData": {
            "PartnerCode": "BRIAPI02",
            "PartnerName": "BRIAPI 02",
            "FacilityCode": "DF",
            "AccountNumber": "020601501450152",
            "AccountName": "PENGEMBANGAN PRODUK",
            "AccountStatus": "Active",
            "LoanDueDate": "2024-05-23",
            "Plafon": "1000000",
            "Outstanding": "500000.00",
                "HoldAmount": "150000",
                "AvailableAmount": "350000.00",
                "FacilityStatus": "00",
                "FacilityStatusDesc": "Active"",
                "LastInvoiceDefault": ""
            }
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message
200	00	Success	Inquiry Success
403	10		Unauthorize access
403	11		CBM-CorporateRequestId can not duplicate
400	01		Invalid data request.{Specific Desc}.
400	02		Action cannot be processed.{Specific Desc}.
400	03		Action cannot be processed.{Specific Desc}.
500	99		General Error

L. Facility Payment

Endpoint Description

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

General Information

HTTP Method	POST
Path	/v1/apicbm/invoices/facility_payment
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Accept	application/json
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_idand client_secretfrom the BRIAPI get token endpoint. Format:Bearer{access_token} Example:BearermAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format:yyyy-mm-ddThh:mm:ss.SSSZ Example:2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format:{generated_signature} Example:vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format:Bearer {CBM Token} Example:Bearer7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Request Structure & Sample

Field	Data Type	Mandatory	Length	Description
ReferenceNumber	string	M	19	Referral number obtained when successfully creating an invoice to CBM (create invoice).
InvoiceNumber	string	M	30	Invoice number issued by the invoice issuing company.
Amount	numeric string	O		The amount to be paid against the invoice.

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber":"VF0002123000037636",
            "InvoiceNumber":"SB-20230829-991"
        }

Normal Response :

        {
            "responseCode":"00",
            "responseDesc":"Facility Payment successful.",
            "responseData": {
            "ReferenceNumber":"VF0002123000037636",
            "Message":"Invoice Number SB-20230829-99 paid"
            }
        }

Error Response :

        {
            "responseCode": "03",
            "responseDesc": "Action cannot be processed. facility payment not allowed, current status is facipay approved",
            "responseData": null
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message	Description
200	00	Success	Inquiry Success

M. Instapay

Endpoint Description

This endpoint is used to perform instant disbursement of DF invoices to new ARK invoices.

General Information

HTTP Method	POST
Path	/v1/apicbm/invoices/insta_payment
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Accept	application/json
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_idand client_secretfrom the BRIAPI get token endpoint. Format:Bearer{access_token} Example:BearermAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format:yyyy-mm-ddThh:mm:ss.SSSZ Example:2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format:{generated_signature} Example:vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format:Bearer {CBM Token} Example:Bearer7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Request Structure & Sample

Field	Data Type	Mandatory	Length	Description
ReferenceNumber	string	M	19	Referral number obtained when successfully creating an invoice to CBM (create invoice).
InvoiceNumber	string	M	30	Invoice number issued by the invoice issuing company.
DisbursementDate	date	M	10	The scheduled payment date of the AR invoice. (formatyyyy-MM-dd).

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber":"DF0002123000037636",
            "InvoiceNumber":"SB-20230829-991",
            "DisbursementDate":"2024-06-17"
        }

Normal Response :

        {
            "responseCode":"00",
            "responseDesc":"Facility Payment successful.",
            "responseData": {
            "ReferenceNumber":"ARK0002123000037636",
            "Message":"Insta-payment for invoice SB-20230829-991 has been created"
            }
        }

Error Response :

        {
            "responseCode": "01",
            "responseDesc": "Invalid data request. DisbursementDate must greater or equal than today",
            "responseData": null
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message	Description
200	00	Success	Inquiry Success

N. Re-enable Settlement Date (Settlement-Request)

Endpoint Description

This endpoint is used to reactivate the settlement date in a dispute. Only works for companies with manual settlement configuration.

General Information

HTTP Method	POST
Path	/v1/apicbm/settlement/request
Type Format	JSON
Authentication	OAuth 2.0

Header Structure

Key	Value	Format	Mandatory	Description
Accept	application/json
Authorization	Authorization	Alphanumeric	M	Access token obtained using the client_idand client_secretfrom the BRIAPI get token endpoint. Format:Bearer{access_token} Example:BearermAULq4APLGPvmIzvG36b3xGTQUcc
BRI-Timestamp	BRI - Timestamp	Datetime	M	Time when making a request to the endpoint Format:yyyy-mm-ddThh:mm:ss.SSSZ Example:2023-10-02T05:55:43.162Z
BRI-Signature	BRI - Signature	Alphanumeric	M	Signature request yang di-generate menggunakan algoritma HMAC-SHA256 Format:{generated_signature} Example:vaW4Gbdm59BZ68RsApcBlrjONQFudLRhN5Em+uI5JP0=
Content-Type	application/json	Alpha	M	application/json
CBM-CorporateKey		Alphanumeric	M	Unique Corporate code obtained when registering for API CBM. Format:Bearer {CBM Token} Example:Bearer7f023e13be0f368dce8a560fbb527f7e7a1938a963f6a97e636a4d93c5ce223a2b10df88f693181eb9060947ab53340b1a4a8f188c7116f517036aaf42331
CBM-CorporateRequestId		Alphanumeric	M	Unique request code prepared by the partner.

Request Structure & Sample

Field	Data Type	Mandatory	Length	Description	Example
ReferenceNumber	string	M	19	Referral number obtained when successfully creating an invoice to CBM (create invoice).
InvoiceNumber	string	M	30	Invoice number issued by the invoice issuing company.

Request and Response Payload Sample

Request :

        {
            "ReferenceNumber":"VF0002123000037636",
            "InvoiceNumber":"SB-20230829-991"
        }

Normal Response :

        {
            "responseCode":"00",
            "responseDesc":"Facility Payment successful.",
            "responseData": {
            "ReferenceNumber":"VF0002123000037636",
            "Message":"Invoice Number SB-20230829-99 paid"
            }
        }

Error Response :

        {
            "responseCode": "03",
            "responseDesc": "Action cannot be processed. Invoice not found",
            "responseData": null
        }

List of Error/Response Code

HTTP Status	Code	Status	Response Message	Description
200	00	Success	Inquiry Success

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 data request
401	0601	Invalid Token	Error in validating token
401	0602	Invalid Signature	Error in validating signature
401	0603	Unauthorized. Client Forbidden Access API	Client does not have access to the API
500	0500	General Error	An unexpected problem occurred
503	0503	Service Unavailable	Error when accessing the product used
504	0504	Gateway Timeout	Connection timeout