Business Group Commissions BETA

API Business Group Commissions adalah layanan untuk Bisnis Induk mengatur aturan komisi grup, melihat daftar konfigurasi komisi per channel, dan melakukan pratinjau perhitungan komisi.

info

Seluruh endpoint di halaman ini hanya dapat diakses oleh Bisnis Induk dengan credentials SNAP API.

Common Requirements

• Authentication: Bearer Access Token yang didapat dari API access token.
• Signature: X-SIGNATURE menggunakan skema symmetric signature.
• Timestamps: X-TIMESTAMP format ISO-8601 dengan timezone offset.

Common Headers

Header	Tipe	Mandatori	Keterangan
Authorization	string	✓	Bearer <access_token>
Content-Type	string	✓	application/json
X-TIMESTAMP	string	✓	Waktu permintaan (ISO-8601)
X-SIGNATURE	string	✓	Signature simetris
X-PARTNER-ID	string	✗	Diisi string kosong
X-CLIENT-KEY	string	✓	Client key dashboard
X-EXTERNAL-ID	string(64)	✓	Request ID unik
CHANNEL-ID	string	✗	Rekomendasi KIRIMO

Set Account

Endpoint ini digunakan oleh Bisnis Induk untuk membuat atau memperbarui konfigurasi komisi grup pada suatu channel pembayaran. Konfigurasi dapat berupa persentase, nominal tetap, atau kombinasi keduanya. Jika kedua nilai diisi, maka sistem akan menambahkan keduanya saat menghitung komisi. Bila konfigurasi komisi tidak diset, maka saat anggota dari business group bertransaksi, tidak ada komisi yang diambil untuk business induk.

info

1. API ini bersifat upsert akan membuat data apabila belum diset dan akan melakukan update bila sebelumnya sudah ada
2. Max dari groupCommissionPercentage adalah 70
3. Min dari groupCommissionPercentage adalah 0
4. Jika perhitungan commission lebih besar (>) dibanding nett amount transaction maka commission akan mengambil seluruh nett amount
5. Isi dengan nilai 0 untuk menonaktifkan perhitungan komisi

• Method: POST
• Path: /api/v1.0/accounts
• Type: application/json

Request Body

Parameter	Tipe	Mandatori	Keterangan
businessId	number	✓	ID bisnis untuk diset value commission
channelCode	string	✓	Kode channel pembayaran, untuk development gunakan NQ. Untuk production, channel code akan diinfokan selanjutnya.
groupCommissionPercentage	number	✓	Persentase komisi grup dalam %. Hanya bisa dua angka di belakang koma
groupCommissionFixed	number	✓	Komisi tetap dalam rupiah

Request Example

{
  "method": "POST",
  "url": "https://{API_URL}/api/v1.0/accounts",
  "headers": {
    "Authorization": "Bearer <access_token>",
    "Content-Type": "application/json",
    "X-TIMESTAMP": "2025-09-18T13:40:07+07:00",
    "X-SIGNATURE": "oOZKhItvfcpY2AeyZZLL9o2rSN7JtlTCKx6bIHdIzqi5+pW3dWefny/wtkkcEfkyDGyKUnEufAGz8k4/zCSgsg==",
    "X-PARTNER-ID": "",
    "X-CLIENT-KEY": "01K0RNG48BQ8EGPXFMN95ZJESQ",
    "X-EXTERNAL-ID": "6472406",
    "CHANNEL-ID": "KIRIMO"
  },
  "body": {
    "businessId": 1,
    "channelCode": "NQ",
    "groupCommissionFixed": 0,
    "groupCommissionPercentage": 2.0
  }
}

Response

{
  "status": "SUCCESS",
  "businessId": "1",
  "channelCode": "NQ",
  "groupCommissionPercentage": 2,
  "groupCommissionFixed": 1000,
  "minCommission": 0,
  "maxCommission": 0,
  "responseCode": "2000000",
  "responseMessage": "Request has been processed successfully"
}

Get Accounts

Endpoint ini menampilkan seluruh daftar akun yang dimiliki oleh Bisnis Induk. Mendukung filtering menggunakan businessId dan/atau channelCode. Gunakan endpoint ini untuk menampilkan daftar komisi yang sedang berlaku di dashboard atau laporan.

• Method: GET
• Path: /api/v1.0/accounts
• Type: application/json

Query Parameters

Nama	Tipe	Mandatori	Keterangan
businessId	number	✗	Filter ID bisnis
channelCode	string	✗	Filter channel code

Request Example

{
  "method": "GET",
  "url": "https://{API_URL}/api/v1.0/accounts?businessId=1",
  "headers": {
    "Authorization": "Bearer <access_token>",
    "Content-Type": "application/json",
    "X-TIMESTAMP": "2025-09-18T13:39:41+07:00",
    "X-SIGNATURE": "dg7A64pT7/4CkXxpgw2UAkWrniv6Fy+zddlF9xszS+7YudA63GXIK2+NA5oHFrbTrsqI3SbGpwDjEJldzP5Ybw==",
    "X-PARTNER-ID": "",
    "X-CLIENT-KEY": "01K0RNG48BQ8EGPXFMN95ZJESQ",
    "X-EXTERNAL-ID": "2819152",
    "CHANNEL-ID": "KIRIMO"
  }
}

Response

{
  "data": [
    {
      "businessId": "1",
      "businessName": "test0407-03",
      "channelCode": "NQ",
      "groupCommissionPercentage": 2,
      "groupCommissionFixed": 1000,
      "minCommission": 0,
      "maxCommission": 0
    }
  ],
  "responseCode": "2000000",
  "responseMessage": "Request has been processed successfully"
}

Preview Commission

Endpoint ini digunakan untuk melakukan simulasi perhitungan komisi berdasarkan nominal transaksi tertentu (amount) dan channel pembayaran yang dipilih. Sangat berguna untuk menampilkan pratinjau potongan komisi kepada merchant sebelum diaplikasikan.

• Method: POST
• Path: /api/v1.0/accounts/:business_id/commission-preview
• Type: application/json

Request Body

Parameter	Tipe	Mandatori	Keterangan
amount	number	✓	Nominal dasar yang akan dihitung komisinya
channelCode	string	✓	Channel code

Request Example

{
  "method": "POST",
  "url": "https://{API_URL}/api/v1.0/accounts/1/commission-preview",
  "headers": {
    "Authorization": "Bearer <access_token>",
    "Content-Type": "application/json",
    "X-TIMESTAMP": "2025-09-18T13:13:45+07:00",
    "X-SIGNATURE": "rEdWV5qg2cgfThw0nyDRMlrKgM+BsjKciN3WQFhjX2uqEH2R1aangKoF4XZhxvTd+q6N3VmdS02ztSTO8dthaA==",
    "X-PARTNER-ID": "",
    "X-CLIENT-KEY": "01K0RNG48BQ8EGPXFMN95ZJESQ",
    "X-EXTERNAL-ID": "8133651",
    "CHANNEL-ID": "KIRIMO"
  },
  "body": {
    "amount": 250000,
    "channelCode": "NQ"
  }
}

Response

{
  "baseAmount": 250000,
  "groupCommissionPercentage": 2,
  "groupCommissionFixed": 1000,
  "commissionAmount": 6000,
  "responseCode": "2000000",
  "responseMessage": "Request has been processed successfully"
}