BRImo is one of the Internet banking payment methods provided by Bank BRI. This method allows the customer to perform transactions by redirecting the customer to the BRImo payment page.
The Steps to integrate with BRImo are given below.
- Send the charge API request to Midtrans.
- Redirect the customer to URL specified in the response.
- Redirect your customer back to your page by configuring Finish URL in Midtrans's Dashboard > Configurations.
- Handle notifications.
Send a Charge API request with the details of the transaction such as payment_type
, transaction_details
, item_details
, and customer_details
. Successful request returns a redirect URL.
By default, expiry time for BRImo is 2 hours unless specified by merchant (min 20s, max 180 days).
BRImo Charge API Request
{
"payment_type": "bri_epay",
"transaction_details": {
"order_id": "2014111702",
"gross_amount": 11000
},
"item_details": [
{
"id": "1",
"price": 11000,
"quantity": 1,
"name": "Mobil "
}
],
"customer_details" : {
"first_name": "Andri",
"last_name": "Litani", // Optional
"email": "[email protected]",
"phone": "081122334455"
}
}
JSON Attribute | Description | Type | Required |
---|---|---|---|
payment_type | Set BRImo payment method. Value: bri_epay . | String | Required |
transaction_details | The details of the specific transaction such as order_id and gross_amount . | Object | Required |
item_details | Details of the item(s) purchased by the customer. | Object | Required |
customer_details | Details of the customer. | Object | Required |
BRImo Charge Sample Responses and Notifications
{
"status_code": "201",
"status_message": "Success, BRI E-Pay transaction is successful",
"transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
"order_id": "2014111702",
"redirect_url": "https://api.veritrans.co.id/v3/bri/epay/redirect/f8635cd7-615d-4a6d-a806-c9ca4a56257e",
"gross_amount": "145000.00",
"payment_type": "bri_epay",
"transaction_time": "2016-06-19 16:00:05",
"transaction_status": "pending",
"fraud_status": "accept",
"currency": "IDR"
}
{
"transaction_time": "2016-06-19 16:00:05",
"gross_amount": "145000.00",
"order_id": "2014111702",
"payment_type": "bri_epay",
"signature_key": "2ea1c4b7d7a41700848bbd248b85dd933e9fdff1f4d69fefa8eefac2bf92ac8a78dbc40a78b5d77315b704150bca14fcb76a4c770336295c63369c592787a03f",
"status_code": "201",
"transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
"transaction_status": "pending",
"fraud_status": "accept",
"status_message": "midtrans payment notification"
}
{
"approval_code": "201373311528",
"transaction_time": "2016-06-19 16:04:02",
"gross_amount": "145000.00",
"order_id": "2014111702",
"payment_type": "bri_epay",
"signature_key": "13b6b8a2da46428812e7685463770e3704ece7fc3242a5f016f068b7b135e12a71afd02259fe4dbd8c97d747ae9cf8e13412842325ea8da4cf6d7177e32b7e31",
"status_code": "200",
"transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
"transaction_status": "settlement",
"fraud_status": "accept",
"status_message": "midtrans payment notification"
}
{
"status_code": "202",
"status_message": "midtrans payment notification",
"transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
"order_id": "2014111702",
"gross_amount": "145000.00",
"payment_type": "bri_epay",
"transaction_time": "2016-06-19 18:00:05",
"transaction_status": "expire",
"signature_key": "75969ac3cd1538b860ddb49fce06084eae991093d6d7c4fb653efd0beb19b0f31b3e9c9568f1c1eae3deb988b379a2d7fb5dbf0099190d1a241fc07f4e4a82ed",
}
{
"transaction_time": "2016-06-19 16:04:02",
"gross_amount": "145000.00",
"order_id": "2014111702",
"payment_type": "bri_epay",
"signature_key": "6f4c3f00e391e2a97199ace0c243419b12c58eb9ec698600c25f8e9103573ef5258460484d64d742a4cd221cef33b57e23c1a31efa2480e1490d89163b8079bc",
"status_code": "202",
"transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
"transaction_status": "deny",
"fraud_status": "accept",
"status_message": "midtrans payment notification"
}
JSON Attribute | Description | Type |
---|---|---|
status_code | Status code of transaction charge result. | String |
status_message | Status message describing the result of the API request. | String |
transaction_id | Transaction ID given by Midtrans. | String |
order_id | Order ID specified by you. | String |
redirect_url | Redirect URL to BRImo payment page. | String |
gross_amount | Total amount of transaction in IDR. | String |
payment_type | The payment method used by the customer. | String |
transaction_time | Timestamp of transaction in ISO 8601 format. Time Zone: GMT+7. | String |
transaction_status | Status of BRImo transaction. Possible values arepending , expire , settlement . | String |
fraud_status | Detection result by Fraud Detection System (FDS). Possible values areaccept : Approved by FDS.challenge : Questioned by FDS. Note: Approve transaction to accept it or transaction will get automatically cancelled during settlement.deny : Denied by FDS. Transaction automatically failed. | String |
currency | ISO-4217 representation of three-letter alphabetic currency code. Value: IDR .Note: Currently, only IDR is supported. | String |
signature_key | Combination of parameters such as order_id , status_code , gross_amount , and server_key to verify integrity of payload/response. | String |
approval_code | Successful BRImo transaction approval code. | String |