Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Katalog Produk

Mengembalikan daftar produk yang tersedia untuk merchant berdasarkan API Key yang digunakan.

URL: GET /api/v1/product/inquiry

Autentikasi

Endpoint ini menggunakan API Key via header X-API-Key. Tidak memerlukan Signature Validation.

Request

Tidak ada parameter atau body — cukup kirim GET request dengan API Key.

curl --location 'https://api-sandbox.alfakios.com/api/v1/product/inquiry' \
  --header 'X-API-Key: apk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Response

Field data berisi array flat produk yang tersedia.

Spesifikasi per Produk

FieldTipeKeterangan
operatorStringNama operator/provider produk
product_idStringKode produk — gunakan nilai ini di field product_id pada request transaksi
denomStringDenominasi/nilai produk ("0" = harga dinamis berdasarkan nominal)
descriptionStringDeskripsi produk
unit_priceStringHarga jual dalam IDR ("0" = harga dinamis)
statusStringOPEN, CLOSED, atau MAINTENANCE

Contoh Response

{
  "success": true,
  "message": "Products retrieved successfully",
  "rc": "000",
  "data": [
    {
      "operator": "Bank Transfer",
      "product_id": "DSTF",
      "denom": "0",
      "description": "Disbursement Transfer",
      "unit_price": "0",
      "status": "OPEN"
    },
    {
      "operator": "Token PLN",
      "product_id": "PLNPREP",
      "denom": "0",
      "description": "PLN Token Prabayar",
      "unit_price": "0",
      "status": "OPEN"
    },
    {
      "operator": "PLN Pascabayar",
      "product_id": "PLNPOST",
      "denom": "0",
      "description": "Tagihan PLN Pascabayar",
      "unit_price": "0",
      "status": "OPEN"
    },
    {
      "operator": "BPJS Kesehatan",
      "product_id": "BPJSKS",
      "denom": "0",
      "description": "BPJS Kesehatan",
      "unit_price": "0",
      "status": "OPEN"
    },
    {
      "operator": "GoPay",
      "product_id": "GOPAY",
      "denom": "0",
      "description": "Top-up GoPay",
      "unit_price": "0",
      "status": "OPEN"
    },
    {
      "operator": "XL Axiata",
      "product_id": "XL5",
      "denom": "5000",
      "description": "Pulsa XL Rp 5.000",
      "unit_price": "5500",
      "status": "OPEN"
    },
    {
      "operator": "Telkomsel",
      "product_id": "TSEL10",
      "denom": "10000",
      "description": "Pulsa Telkomsel Rp 10.000",
      "unit_price": "10800",
      "status": "MAINTENANCE"
    }
  ]
}

Catatan Penggunaan

  • Gunakan product_id dari response ini sebagai nilai field product_id pada request transaksi apa pun.
  • Produk dengan status: "MAINTENANCE" atau status: "CLOSED" tidak dapat digunakan untuk transaksi dan akan mengembalikan error rc: "007" atau rc: "006".
  • unit_price: "0" artinya harga dihitung dinamis berdasarkan amount yang dikirim — biaya final tampil di field fee dan total_cost pada response inquiry/payment.
  • Daftar produk bisa berbeda antar merchant tergantung konfigurasi akun.

Integrasi dengan Endpoint Lain

KategoriFieldSumber dari Katalog
PPOBproduct_idproduct_id dengan operator sesuai layanan
Disbursementproduct_idproduct_id: "DSTF" atau produk transfer lainnya
PayIn QRISproduct_idproduct_id: "GPAY"