Direct Debit

Endpoint Description

Create Card Token (Binding) OTP Verify is an endpoint for verifying OTP Binding requests.

Note: OTP and Notifications (Binding and Payment) that were previously sent via SMS will be sent via Whatsapp

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request Example :

curl -X PATCH 'https://sandbox.partner.api.bri.co.id/v1/directdebit/tokens' \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'BRI-Timestamp: 2019-05-14T02:25:06.379Z' \
  -H 'Content-Type: application/json' \
  -H 'X-BRI-Signature: {{SIGNATURE}}' \
  -d '{
    "body":{
        "registration_token": "TOK_TKNCPPPHUVL3IJVAXZI5GG4WBEC77YZ6::ADVQ",
        "passcode": "545195"
    }
}'

Normal Response :

{
"body": {
	"status": "0000",
	"phone_number": "6289912345678",
	"device_id": "09864ADCASA",
	"card_token": "card_.eyJleHAiOjE2ODU0OTExOTksImlhdCI6MTU0MDE5NjUwMCwiaXNzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOi
	JhMGM2MjlhNS1hYWI5LTQ5OWMtODg5MS0yNzA1NDg3NGRmYWUiLCJuYmYiOjE1NDAxOTY1MDEsInBhcnRuZXJJZCI6Iu-_vSIsInNlcnZp
	Y2VOYW1lIjoiRERfRVhURVJOQUxfU0VSVklDRSJ9.hceS_BQtzCIyMJCVMMvPWSfTvqIrW9TIL9arAUi95e-P6Kq9bvmQNuGLcfV6GLnQE
	c07fKF6IaLLkUquEm2iDfsP1HMLv_crXiF9snwzqzTk5vJqYvLmRGDqhZk-tFw-MwX0NW-op2iyRUhwSTB7rCNVOyfeIGfif7dKpu2PdFT
	98VUimnsKRWqHjARuCVKXweDbfKVpLHpgcR914MvSthqt4a7eHzUxm6o6eqyjQjf_vkQi4Fl_iG98JOVuzVuXft5P50QKcKwAhnrIiGMC-
	Vd4DZWQ1rMVbx1iSLvGzBrR1xm3wIYYlmyR0pUVlDdGaE04N1Gz_dvcsgx15Ecw",
	"location": {
		"lat": "",
		"lon": ""
	},
	"last4": "1234",
	"email": " foo.bar@baz.com",
	"metadata": {
		"example1": "example1"
	},
	"card_type": "PVRGLR",
	"limit_transaction": ""
  }
}  
"body": { 
"status": "PENDING_USER_VERIFICATION", 
"token": "TOK_CBF6XTIWO4HKQ3LJ2QPAGW445LORLPF5" 
  } 
}        		

Error Response :

{
"error": {
	"code": "0918",
	"message": "Invalid Passcode"
},
"status_code": 400,
"recorded_at": "2021-02-10T11:09:43Z"
}     			 

List of Error/Response Code

Endpoint Description

The unbinding API is used to delete user account that has been previously registered.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request and Response Payload Sample

Request  Example:

curl -X DELETE 'https://sandbox.partner.api.bri.co.id/v1/directdebit/tokens' \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'BRI-Timestamp: 2019-05-14T02:25:06.379Z' \
  -H 'Content-Type: application/json' \
  -H 'X-BRI-Signature: {{SIGNATURE}}' \
  -d '{
    "body":{
        "card_token": "card_.eyJleHAiOjE1ODkzNDk2ODgsImlhdCI6MTU1NzcyNzI4OCwiaXNzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOiJhNTcxZDA3OC0xYmMyLTQ4NGUtOTQ2NC0yOGMzZmE2MWFhNGQiLCJwYXJ0bmVySWQiOiLvv70iLCJzZXJ2aWNlTmFtZSI6IkREX0VYVEVSTkFMX1NFUlZJQ0UifQ.EUOaGaCI6giha7GmRsycxMBrVXQgeF9cHfonXYZcT_3R3ykXw6PFOS9r32fMVP8al2lf26_Q6VIZ3sm71e7Sbd1KoigtGdcTPeJseSMMP190Ful_2DA2cRqhvN1dzJx-6keaG_AzLzo6sWMzuonQuR9tk-o5YMkGzfHJ-ZOS0zWvmN9lWRmvKlZPOBH_8Q430Yu5CeSjIF9ocfQQ6oguk_bXVRCX-4_u8WYISHrsatIeptBAADpQZktLpjBj0gXELwDed0PXQ4TeArcsUvj7d66hG8KPCuhCWa41JWnDxycqlJK_fldsnY0ewofkudSnSJzg5Nh0FILxl83bBPj4Pw"
    }
}'

Normal Response :

	{
		"body": {
		"status": "0000"
		}
	}
	

Error Response :

	{
		"error": {
		"code": "0006",
		"message": "Invalid card token"
		},
		"status_code": 400,
		"recorded_at": "2021-02-10T11:11:10Z"
	}  
						 
	

List of Error/Response Code

Endpoint Description

This API request is used to display all payment statuses that have been made.

*NOTE: Normal case partner will get payment_id when charge and use it to retrieve the transaction, but if transaction is timeout, partner can make inquiry using Metadata or Remarks. Partners are expected to ensure that the value in Metadata or Remarks is unique since it will be used for transaction inquiry. If not, the inquiry result will return the last data.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

* NOTE: Use "payment_status" to identify whether the payment is SUCCESS or FAILED

Array Refund History

* NOTE: Use "status" to identify whether a payment is SUCCESS or FAILED

Request and Response Payload

Request Example :

curl -X POST 'https://sandbox.partner.api.bri.co.id/v1/directdebit/charges/inquiry' \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'BRI-Timestamp: 2019-05-14T02:25:06.379Z' \
  -H 'Content-Type: application/json' \
  -H 'X-BRI-Signature: {{SIGNATURE}}' \
  -d '{
    "body" : {
        "payment_id": "657314642873",
        "remarks":"payment directlink",
        "metadata": {
            "trx_id": "0007654321"
        }
    }
  }'

Normal Response :

{
"body": {
	"status": "0000",
	"amount": "50000.00",
	"currency": "IDR",
	"payment_id": "657314642873",
	"remarks_merchant": "payment directlink",
	"payment_status": "SUCCESS",
	"refund_history": [
		{
			"refund_id": "447343838470",
			"amount": "10000.00",
			"currency": "IDR",
			"reason": "incorrect stuff",
			"date": "2019-08-28T02:28:30.246199Z",
			"status": "SUCCESS",
			"device_id": "lg-lllll",
			"location": {
				"lat": "",
				"lon": ""
			},
			"metadata": {
				"trx_id_ref": "000012345000"
			}
		}
	],
	"device_id": "lg-lllll",
	"location": {
		"lat": "",
		"lon": ""
	},
	"metadata": {
		"trx_id_pay": "0007654321"
	}
}
}

Error Response :

{
	"error": {
		"code": "0301",
		"message": "Payment id not found"
	},
	"status_code": 400,
	"recorded_at": "2021-02-10T11:15:43Z"
}

List of Error/Response Code

Endpoint Description

This API is used for payments from transactions with direct links based on the card number on card_token obtained from the binding process(card token creation).

Payment will be interrupted when: 1. The currency used for the transaction is not yet supported. 2. The payment amount exceeds the customer's credit limit or there is not enough funds in the account (determined by the bank). 3. The customer's account or card is no longer active. For each of the above cases, customer funds should not be debited.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample for use OTP

Response Structure & Sample for not use OTP

Request and Response Payload

Request Example:

curl -X POST 'https://sandbox.partner.api.bri.co.id/v1/directdebit/charges' \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'BRI-Timestamp: 2019-05-14T02:25:06.379Z' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 0.6434517166433735' \
  -H 'X-BRI-Signature: {{SIGNATURE}}' \
  -d '{
    "body":{
        "card_token":        "card_.eyJleHAiOjE1ODkzNTA4NDEsImlhdCI6MTU1NzcyODQ0MSwiaXNzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOiJlM2YzNTQxNC00MTc4LTRlYzgtYmY2Ny03MjI2MzkyNjY3YTciLCJwYXJ0bmVySWQiOiLvv70iLCJzZXJ2aWNlTmFtZSI6IkREX0VYVEVSTkFMX1NFUlZJQ0UifQ.PMuH4Fq9TkacFSQE2nwr-Dr7icRPlOOxYv2_XeoOjzidTm8dRwD9xy1lpvc_JJiUUQ_WFsL-o267BkL4tpnUWNxjA0ggnfsIsJQzZUSKtQYPozi7ZSLgV4VHOMqDJxBAFb-TeuNhN6obQBpsWBc4g3e0iOvEWKvk56AviR9Hs-CIQvqoYUEds8PgOyWCdbCnT76LLBzBWjML6JVXSMbtR-J3nDvE4ykq_ajDkgVeHbgFiTPiBtnsXVskbDGZMma1kVijr5GS4cxdqAq7xzYRnFpbVNHyxUrzVKYrGGgYoHM6K3-zM8wlhfHqssjyO86DyvdmfTF1398ZT-B8uv9zog",
        "amount":"25099.00",
        "currency":"IDR",
        "remarks":"Remakrs Merchant",
        "otp_bri_status": "YES",
        "metadata":{
            "trx_id":"12345687"
        }
     "callback_url": "http://(url_partner)/directdebit/notif/charges"
    }
}'

Normal Response Using OTP :

{
	"body": {
		"charge_token": "CHARGE_M3AVZN3LQSX5Q3YZSUHDLT7UAUMANZAP",
		"status": "PENDING_USER_VERIFICATION"
	}
}
	

Normal Response without OTP :

{
	"body": {
		"status": "0000",
		"payment_id": "175226995569",
		"amount": "20000.00",
		"currency": "IDR",
		"remarks": "payment",
		"device_id": "",
		"payment_status": "SUCCESS",
		"location": {
			"lat": "-6.21462",
			"lon": "106.84513"
		},
		"metadata": {
			"payment_id": "0984645728"
		}
	}
}                		    

Error Response (applies to using OTP or without OTP) :

{
	"error": {
		"code": "0006",
		"message": "Invalid card token"
	},
	"status_code": 400,
	"recorded_at": "2021-02-10T11:11:10Z"
}                    

List of Error/Response Code with OTP

List of Error / Response Code for those without OTP

Endpoint Description

This API is used to verify OTP payments from transactions.

Note: OTP and Notifications (Binding and Payment) that were previously sent via SMS will be sent via Whatsapp

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request and Response Payload

Request example:

curl -X POST 'https://sandbox.partner.api.bri.co.id/v1/directdebit/charges/verify' \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'BRI-Timestamp: 2019-05-14T02:25:06.379Z' \
  -H 'Content-Type: application/json' \
  -H 'X-BRI-Signature: {{SIGNATURE}}' \
  -d '{
    "body":{
        "card_token": "card_.eyJleHAiOjE1ODk0MjE0MzcsImlhdCI6MTU1Nzc5OTAzNywiaXNzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOiIxMGI4M2U2Yy0zMmUxLTQxNDctYjI5My01OTg5YWU3Nzk5NTYiLCJwYXJ0bmVySWQiOiLvv70iLCJzZXJ2aWNlTmFtZSI6IkREX0VYVEVSTkFMX1NFUlZJQ0UifQ.MAdArs3zmCsehnWcwhA5m-fwCUory6oudxVtmMS9dC7bXCnRjq91AwRxBADjWLu2S6Ra_RxRAnHU03_H8QJclvLad9L6P-pqZX_pRKDPOI1Y_i0xVYOfc8ea6B2so1aEuvFoOQNFMbGSsaLz4JO-OuJ6EYfoApTFSMIKOh__jkcxcXqpM1sO3ZlkquXKGpx_zf87boVPNY58KbIPWgzCC-6V2Vxpm4DPGunKkEwVMz4z12vTTbv3Ph9rc1Gf0jRXw8b8wo3k2ZeVGoHwiKbyJ_8J7FTVxkm3funDpcQtPzFzgBMPRgWWtfT7IOZddrVwsFt9FKLUKLHTVyiu5R4ZYw",
        "charge_token":  "CHARGE_XEHK6S4SNTBRSTCFBDB65W3GHQXBEFI4::De5g",
        "passcode":"210074"
    }
}'

Normal Response :

{
	"body": {
		"status": "0000",
		"payment_id": "175226995569",
		"amount": "20000.00",
		"currency": "IDR",
		"remarks": "payment",
		"device_id": "",
		"payment_status": "SUCCESS",
		"location": {
			"lat": "-6.21462",
			"lon": "106.84513"
		},
		"metadata": {
			"payment_id": "0984645728"
		}
	}
}                  			  

Error Response :

{
	"error": {
	  "code": "0403",
	  "message": "charge payment failed"
	},
	"status_code": 400,
	"recorded_at": "2021-02-10T05:36:27Z"
 }                     

List of Error/Response Code

Endpoint Description

Refund API is used to make a refund request for a previous success payment. Refund can be done with full or partials amount.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request and Response Payload

Request Example:

curl -X POST 'https://sandbox.partner.api.bri.co.id/v1/directdebit/refunds' \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'BRI-Timestamp: 2019-05-14T02:25:06.379Z' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 0.6434517166433735' \
  -H 'X-BRI-Signature: {{SIGNATURE}}' \
  -d '{
  "body": {
    "card_token": "card_.eyJleHAiOjE1ODMzOTM4OTIsImlhdCI6MTU1MTc3MTQ5MiwiaXNzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOiIyNWQ4MWZmNy04NmY3LTQ5NWItYWUwNi04MTQ1ZGRlMTI1MmMiLCJwYXJ0bmVySWQiOiLvv70iLCJzZXJ2aWNlTmFtZSI6IkREX0VYVEVSTkFMX1NFUlZJQ0UifQ.tVaYUv8VZSbAr6_wQCDCQuGiD_5malWPu33RCTM9l1N0cGHTLO5Czh6SYGxT4tfFLRAesfNB1qBKtPc0SA_bMHkJDsQ8E68KPDpoIEkh33BxHrStrordGy6-De9jDKleHmz1qos4h0ZeYT-vetBjWkhugOZgYQBRJDKT0z7GhRa5MtkK8X4yV2zXypZiDy_AZd7TJH9AvMt5zH6duyfLDtfqf5DmS6gnG5DwbwLPSYm7WlTJ8UTh94kZjdQW-t-UEVHfatNyitayQmZVwRkWwz-TyUABzZWgRluu4Hfsp_jTydYr_yEhv0TE-CFCgP7RmDNJEqpQ2q4DXFtD3i3oOg",
    "amount":"500.00",
    "payment_id": "989453118305",
    "currency": "IDR",
    "reason": "PARTNERREFUND",
    "metadata": {
            "trx_id": "12345687"
        }
    "callback_url": "http://(url_partner)/directdebit/notif/refunds"
    }
}'

Normal Response :

{
"body": {
	"status": "0000",
	"refund_id": "6218763823",
	"payment_id": "89937492374",
	"amount": "20000.00",
	"currency": "IDR",
	"reason": "incorrect stuff",
	"refund_status": "SUCCESS",
	"device_id": "lg-lllll",
	"location": {
		"lat": "-6.21462",
		"lon": "106.84513"
	},
	"metadata": {
		"example1": "example1"
	}
}
}	

Error Response :

{
	"error": {
		"code": "0504",
		"message": "refund payment failed to get payment id"
	},
	"status_code": 400,
	"recorded_at": "2021-02-10T11:22:03Z"
}                     

List of Error/Response Code

Endpoint Description

Callback API for send notification charges

*NOTE: Transaction is successful if parameter status = 0000 and parameter payment_status = SUCCESS, while the transaction fails if parameter status = 0000 and parameter payment_status = FAILED

General Information

Header Structure & Sample

Example for payload signature:

path=/directdebit/notif/refunds&verb=POST&token={{Merchant-Key}}&timestamp=2019-01-02T13:14:15.678Z&body={{Body Payload}}

The payload data will be signed with SHA256-HMAC algorithm using your client_secret. The signature is formed by the specified payload. The signature value is then encoded with Base64 and filled into API requests header X-BRI-Signature.

Request Structure & Sample

Response Structure & Sample

List of Error/Response Code

Request and Response Payload 

Request Example:

curl --location --request POST '{{url}}/directdebit/notif/charges' \
--header 'X-BRI-Signature: PkP3lY+lCxxF4zoMwnKpPZs3Zn0kvl5HawRwzrFzBkQ=' \
--header 'BRI-Timestamp: 2021-01-26T09:59:03.884Z' \
--header 'Content-Type: application/json' \
--header 'Merchant-Key: k8IkLp5ndDZz3zCgZpwdtQ' \
--data-raw '{
	"body": {
		"status": "0000",
		"payment_id": "950414364491",
		"amount": "1000.00",
		"currency": "IDR",
		"remarks": "testing",
		"device_id": "",
		"payment_status": "SUCCESS",
		"location": {
			lat": "",
			lon": ""
		},
		metadata": {
			trx_id": "12345687"
		},
		limit_transaction": "-"
	}
}'

Response :

{
	"response_code": "0000",
	"response_description": "success",
}	

Endpoint Description

Callback API for send notification refund

*NOTE: Refund is successful if parameter status = 0000 and parameter refund_status = SUCCESS, while refund fails if parameter status = 0000 and parameter refund_status = FAILED

General Information

Header Structure & Sample

Example for payload signature:

path=/directdebit/notif/refunds&verb=POST&token={{Merchant-Key}}&timestamp=2019-01-02T13:14:15.678Z&body={{Body Payload}}

The payload data will be signed with SHA256-HMAC algorithm using your client_secret. The signature is formed by the specified payload. The signature value is then encoded with Base64 and filled into API requests header X-BRI-Signature.

Request Structure & Sample

Response Structure & Sample

List of Error/Response Code

Request and Response Payload 

Request Example :

curl --location -g --request POST '{{url}}/directdebit/notif/refunds' \
--header 'X-BRI-Signature: PkP3lY+lCxxF4zoMwnKpPZs3Zn0kvl5HawRwzrFzBkQ=' \
--header 'BRI-Timestamp: 2021-01-26T09:59:03.884Z' \
--header 'Content-Type: application/json' \
--header 'Merchant-Key: k8IkLp5ndDZz3zCgZpwdtQ' \
--data-raw '{
	body": {
		status": "0000",
		refund_id": "6218763823",
		payment_id": "89937492374",
		amount": "20000.00",
		currency": "IDR",
		reason": "incorrect stuff",
		refund_status": "SUCCESS",
		device_id": "lg-lllll",
		location": {
			lat": "-6.21462",
			lon": "106.84513"
		},
		metadata": {
			example1": "example1"
		}
	}
}'

Response :

{
	"response_code": "0000",
	"response_description": "success",      
}
	

Common Error