Direct Debit v1.2

*Notes
 Perubahan ini berlaku mulai tanggal 14 Agustus 2023

Unduh Postman

Introduction Part

Fitur pembayaran e-Commerce yang menghubungkan akun e-Commerce Anda dengan kartu debit BRI sebagai Source of Fund (SoF) sehingga proses pembayaran transaksi berlangsung cepat dengan satu proses registrasi.

Flow API (actor interaction)

Sequence Diagram

1. Binding Step

    

2. Payment Step

   

3. Refund Step

   

Standards (items that applicable for all endpoint)

• Semua datatime harus dalam format ISO 8601.

Additional Requirement

Partner yang memiliki lisensi PCI-DSS, card_pan dapat dikirimkan dalam format penuh (16 digit), jika tidak hanya dikirimkan 4 digit terakhir.

Remark Rekening Koran

16 karaketer (DRDBT/DRRFN+5 digit kode partner+2 digit kode transaksi+4 digit terakhir kartu)+spasi+12 digit paymentid+spasi+10 karakter trx_id partner yang diambil dari (metadata>trx_id / metadata>trx_refund_id).

Catatan: OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp.

Endpoint

Endpoint Description

Binding API memverifikasi bahwa informasi yang diberikan oleh pengguna cocok dengan data bank. Card_token yang diperoleh memiliki masa aktif satu tahun atau setelah masa berlaku kartu habis. Jika card_token telah kedaluwarsa, pengguna diharuskan binding lagi untuk mendapatkan card_token baru untuk melakukan transaksi.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request & Response Payload Sample

Request:

{
curl -X POST 'https://sandbox.partner.api.bri.co.id/v1.2/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_pan": "5221123456789101",
 "phone_number": "6289912345678",
 "email":"foo.bar@baz.com"
 }
}'                                  

Normal Response :

{
 "body": {
 "status": "PENDING_USER_VERIFICATION",
 "token": "TOK_CBF6XTIWO4HKQ3LJ2QPAGW445LORLPF5"
 }
}
            

Error Response :

{
   "error": {
      "code": "0113",
      "message": "Card Information Invalid"
  },
    "status_code": 400,
    "recorded_at": "2021-02-10T11:07:28Z"
  }                              

List of Error/Response Code

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

Create Card Token (Binding) OTP Verify adalah endpoint untuk memverifikasi permintaan Binding OTP.

Catatan: OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp.

General Information  

Header Structure & Sample 

Request Structure & Sample  

Response Structure & Sample  

Error Response Structure & Sample

Request & Response Payload Sample

Request:

{
curl -X PATCH 'https://sandbox.partner.api.bri.co.id/v1.2/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_.eyJleHAiOjE2ODU0OTExOTksImlhdCI6MTU0MDE5NjUwMCwiaXNzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOiJhMGM2MjlhNS1hYWI5LTQ5OWMtODg5MS0yNzA1NDg3NGRmYWUiLCJuYmYiOjE1NDAx
OTY1MDEsInBhcnRuZXJJZCI6Iu_vSIsInNlcnZpY2VOYW1lIjoiRERfRVhURVJOQUxfU0VSVklDRSJ9.hceS_BQtzCIyMJCVMMvPWSfTvqIrW9TIL9arAUi95e-
P6Kq9bvmQNuGLcfV6GLnQEc07fKF6IbaLLkUquEm2iDfsP1HMLv_crXiF9snwzqzTk5vJqYvLmRGDqhZk-tFw-
MwX0NWop2iyRUhwSTB7rCNVOyfeIGfif7dKpu2PdFT98VUimnsKRWqHjAR7uCVKXweDbfKVpLHpgcR914MvSthqt4a7eHzUxm6o6eqyjQjf_vkQi4Fl_iG98JOVuzVuXft5P50QKcKwAhnrIiGMCVd4DZWQ1rMVbx1iS
LvGzBrR1xm3wIYYlmyR0pUVlDdGaE04N1Gz_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  

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

API unbinding digunakan untuk menghapus akun pengguna yang telah terdaftar sebelumnya.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request & Response Payload Sample

Request:

{
curl -X DELETE 'https://sandbox.partner.api.bri.co.id/v1.2/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.EUOaGaCI6giha7
GmRsycxMBrVXQgeF9cHfonXYZcT_3R3ykXw6PFOS9r32fMVP8al2lf26_Q6VIZ3sm71e7Sbd1KoigtGdcTPeJseSMMP190Ful_2DA2cRqhvN1dzJx-6keaG_AzLzo6sWMzuonQuR9tk-o5YMkGzfHJ-ZOS0zWvmN9lWRmvKlZPOBH_8Q430Yu5CeSjIF9ocfQQ6oguk_bXVRCX4_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

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

Permintaan API ini digunakan untuk menampilkan semua status pembayaran yang telah dibuat.

*NOTE:Normal case partner akan mendapatkan payment_id saat charge dan menggunakannya untuk inquiry transaksi, namun jika transaksi sudah timeout, partner bisa melakukan inquiry menggunakan Metadata.Partner diharapkan untuk memastikan bahwa nilai dalam Metadata unik karena akan digunakan untuk inquiry transaksi. Jika tidak, hasil inquiry akan mengembalikan data terakhir.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

CATATAN:Gunakan "payment_status" untuk mengidentifikasi apakah pembayaran SUCCESS atau FAILED

Structure Array Refund History

CATATAN: Gunakan "status" untuk menentukan apakah pembayaran berhasil atau gagal.

Error Response Structure & Sample

CATATAN:Gunakan "payment_status" untuk mengidentifikasi apakah pembayaran SUCCESS atau FAILED

Request & Response Payload Sample

Request:

v{ curl -X POST 'https://sandbox.partner.api.bri.co.id/v1.2/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", "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": "000012345000"
        }
      }
    ],
        "device_id": "lg-lllll",
        "location": {
           "lat": "",
           "lon": ""
      },
        "metadata": {
        "trx_id": "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

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

API ini digunakan untuk pembayaran dari transaksi berdasarkan nomor kartu kartu  pada card_token yang diperoleh dari proses bidning (pembuatan token kartu).

{
    curl -X POST 'https://sandbox.partner.api.bri.co.id/v1.2/directdebit-enterprise/charges/multiple' \
 -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.PMuH4Fq9TkacFS
QE2nwr-Dr7icRPlOOxYv2_XeoOjzidTm8dRwD9xy1lpvc_JJiUUQ_WFsL-o267BkL4tpnUWNxjA0ggnfsIsJQzZUSKtQYPozi7ZSLgV4VHOMqDJxBAFb-TeuNhN6obQBpsWBc4g3e0iOvEWKvk56AviR9Hs-CIQvqoYUEds8PgOyWCdbCnT76LLBzBWjML6JVXSMbtRJ3nDvE4ykq_ajDkgVeHbgFiTPiBtnsXVskbDGZMma1kVijr5GS4cxdqAq7xzYRnFpbVNHyxUrzVKYrGGgYoHM6K3-zM8wlhfHqssjyO86DyvdmfTF1398ZT-B8uv9zog",
 "amount":"25099.00",
 "currency":"IDR",
"giro_account_no":"020601006205303",
"Remarks":"Remarks Merchant",
"otp_bri_status":"YES",
"metadata":{
  "trx_id":"12345687"
     }
   }
}'

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

{
 "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",
"trx_id":"12345687"
 }
 }
}
      

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

Endpoint Description

Catatan: OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp.

   url -X POST 'https://sandbox.partner.api.bri.co.id/v1.2/directdebit/charges/multiple/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_.eyJleHAiOjE1ODk0MjE0MzcsImlhdCI6MTU1Nzc5OTAzNywiaX
         NzIjoiQmFuayBCUkkgLSBEQ0UiLCJqdGkiOiIxMGI4M2U2Yy0zMmUxLTQxNDctYjI5My
        01OTg5YWU3Nzk5NTYiLCJwYXJ0bmVySWQiOiLvv70iLCJzZXJ2aWNlTmFtZSI6IkREX0V
         YVEVSTkFMX1NFUlZJQ0UifQ.MAdArs3zmCsehnWcwhA5m-fwCUory6oudxVtmMS9d
         C7bXCnRjq91AwRxBADjWLu2S6Ra_RxRAnHU03_H8QJclvLad9L6P-pqZX_pRKDPOI1Y
          _i0xVYOfc8ea6B2so1aEuvFoOQNFMbGSsaLz4JO-OuJ6EYfoApTFSMIKOh__jkcxcXqpM
         1sO3ZlkquXKGpx_zf87boVPNY58KbIPWgzCC-6V2Vxpm4DPGunKkEwVMz4z12vTTbv
         3Ph9rc1Gf0jRXw8b8wo3k2ZeVGoHwiKbyJ_8J7FTVxkm3funDpcQtPzFzgBMPRgWWtfT
         7IOZddrVwsFt9FKLUKLHTVyiu5R4ZYw",
        "charge_token":  "CHARGE_XEHK6S4SNTBRSTCFBDB65W3GHQXBEFI4::De5g",
        "passcode":"210074"
    }
}'

{
 "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": {
"code": "0403",
"message": "charge payment failed"
},
"status_code": 400,
"recorded_at": "2021-02-10T05:36:27Z"
}

Endpoint Description

{
 curl -X POST 'https://sandbox.partner.bri.co.id/v1.2/directdebit/refunds/multiple' \
 -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.tVaYUv8VZS
bAr6_wQCDCQuGiD_5malWPu33RCTM9l1N0cGHTLO5Czh6SYGxT4tfFLRAesfNB1qBKtPc0SA_bMHkJDsQ8E68KPDpoIEkh33BxHrStrordGy6-De9jDKleHmz1qos4h0ZeYTvetBjWkhugOZgYQBRJDKT0z7GhRa5MtkK8X4yV2zXypZiDy_AZd7TJH9AvMt5zH6duyfLDtfqf5DmS6gnG5DwbwLPSYm7WlTJ8UTh94kZjdQW-t-UEVHfatNyitayQmZVwRkWwz-TyUABzZWgRluu4Hfsp_jTydYr_yEhv0TE-CFCgP7RmDNJEqpQ2q4DXFtD3i3oOg",
 "amount":"500.00",
 "payment_id": "989453118305",
"giro_account_no":"020601006205303",
 "currency": "IDR",
 "metadata": {
  "trx_refund_id": "12345687"
 }
 }
}'




                  

{
 "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": {
 "trx_refund_id":"12345687"
 }
 }
}
          

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

Endpoint Description

API ini digunakan untuk pembayaran dari transaksi berdasarkan nomor kartu pada card_token yang diperoleh dari proses bidning (pembuatan token kartu).

Pembayaran akan terhenti jika:

1. Mata uang yang digunakan untuk transaksi belum didukung.

2. Jumlah pembayaran melebihi batas kredit nasabah atau dana di rekening tidak cukup (ditentukan oleh bank).

3. Rekening atau kartu nasabah tidak lagi aktif. Untuk setiap kasus di atas, dana nasabah tidak boleh didebet.

General Information

Header Structure & Sample

Request Structure & Sample

 Response Structure & Sample untuk yang memakai OTP

 Response Structure & Sample untuk yang tanpa OTP

Request & Response Payload Sample

Request:

            curl -X POST ' https://sandbox.partner.api.bri.co.id/v1.2/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 untuk yang memakai OTP:

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

Normal Response untuk yang tanpa 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": {
                    "trx_id":"12345687"
                    }
                 }
              }

Error Response (berlaku untuk memakai OTP atau tanpa OTP):

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

List of Error/Response Code untuk yang memakai OTP

 List of Error/Response Code untuk yang tanpa OTP

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

API ini digunakan untuk memverifikasi Request OTP charge dari transaksi.

Catatan: OTP dan Notif (Binding dan Payment) yang sebelumnya dikirimkan melalui SMS akan dikirimkan melalui Whatsapp.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request & Response Payload Sample

Request:

          curl -X POST 'https://sandbox.partner.api.bri.co.id/v1.2/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

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

API Refund digunakan untuk membuat permintaan pengembalian dana untuk pembayaran yang berhasil sebelumnya. Pengembalian dana dapat dilakukan dengan jumlah penuh atau sebagian.

General Information

Header Structure & Sample

Request Structure & Sample

Response Structure & Sample

Request & Response Payload Sample

Request:

    curl -X POST 'https://sandbox.partner.api.bri.co.id/v1.2/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": "DANAREFUND",
                    "metadata": {
                    "trx_refund_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": {
        "trx_refund_id":"12345687"
        
        }
        }
            

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

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

Callback API untuk mengirim pemberitahuan dari charge

* CATATAN: Transaksi berhasil jika parameter status = 0000 dan parameter payment_status = SUCCESS,

sedangkan transaksi gagal jika parameter status = 0000 dan parameter payment_status = GAGAL

General Information

Header Structure & Sample

Contoh payload signature:

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

Data payload dienkripsi dengan algoritma SHA256-HMAC menggunakan client_secret Anda. Signature dibentuk oleh payload yang sudah ditentukan. Hasil signature kemudian di- encode dengan Base64 dan diisi ke dalam header permintaan API X-BRI-Signature.

Request Structure & Sample

Response Structure & Sample

Request & Response Payload Sample

Request:

    {
        "body": {
        "status": "0000",
        "payment_id": "950414364491",
        "amount": "1000.00",
        "currency": "IDR",
        "remarks": "TESTFEN",
        "device_id": "",
        "payment_status": "SUCCESS",
        "location": {
        "lat": "",
        "lon": ""
        },
        "metadata": {
        "trx_id": "12345687"
        },
        "limit_transaction": "-"
      }
    }
                       
  

Response:

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

List of Error/Response Code

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan

Endpoint Description

Callback API untuk mengirimkan pemberitahuan dari refund

*CATATAN: Refund berhasil jika parameter status = 0000 dan parameter refund_status = SUCCESS,

sedangkan refund gagal jika parameter status = 0000 dan parameter refund_status = FAILED

General Information

Header Structure & Sample

Contoh payload signature:

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

Data payload dienkripsi dengan algoritma SHA256-HMAC menggunakan client_secret Anda. Signature dibentuk oleh payload yang sudah ditentukan. Hasil signature kemudian di- encode dengan Base64 dan diisi ke dalam header permintaan API X-BRI-Signature.

Request Structure & Sample

Response Structure & Sample

Request & Response Payload Sample

Request:

    {
        "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",
        
    }
            

List of Error/Response Code

Common Error

Seluruh response error yang tidak tercantum dalam list response BRIAPI memiliki status pending dan perlu dilakukan pengecekan