Daftar Produk (API)

API NameDaftar produk
FunctionAPI ini digunakan untuk menampilkan daftar seluruh produk.
Service Code13
MethodPOST
URL/snap/v1.0/products/list
Content Typeapplication/json
Related Service

Request​

Header​

NoNameTypeLengthRequiredConditionRemarks
1Content-TypeStringVariable, 127 maxWajib–Tipe konten, nilai selalu application/json
2AuthorizationStringVariableWajib–Berisikan B2B Bearer JWT Token, yang didapatkan dari Access Token B2B
3X-TIMESTAMPStringFixed, 25 maxWajib–Waktu transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Zona waktu harus GMT+7 (Jakarta time)
4X-PARTNER-IDStringVariable, 36 maxWajib–ID untuk mitra yang dihasilkan oleh PakaiLink. Unique ID untuk mitra
5X-EXTERNAL-IDStringVariable, 36 maxWajib–Messaging reference ID unik yang dihasilkan oleh merchant. Numeric String. Nomor referensi harus unik di hari yang sama.
6CHANNEL-IDStringVariable, 5 maxWajib–Identifikasi perangkat dimana API Service ini sedang diakses oleh pengguna. Daftar Channel ID dapat dilihat di sini.
7X-SIGNATUREStringVariableWajib–Signature harus dihasilkan dengan metode Symmetric Signature

Body

NoNameTypeLengthRequiredConditionRemarks
1productTypeproductTypeVariableOptional–Jenis produk yang menunjukkan kelompok layanan
2.productCategoryproductCategoryVariableWajib–Kategori utama produk yang digunakan untuk mengelompokkan produk berdasarkan jenis layanan atau fungsinya

Contoh Request​

POST /snap/v1.0/products/list
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJQQUtBSUxJTksiLCJqdGkiOiIyNDc0NzdlNjk0ZGM3N2FhZDU5YzA4MjA1NzdmZmViNyIsImV4cCI6MTE3NDAyOTc2NzgsImFzIjoicGFydG5lciIsImlkIjoiUFRSMDAwMDAwMyJ9.XmUxHExWILJCHJG74Af8TPJljX2aOmUz4UwJXumxkqxW9uDsIrSX_M_j0uRzPOmaBkk2_rQiHIo_OX_qxv45Mg
Content-Type: application/json
X-TIMESTAMP: 2025-01-30T12:38:12+07:00
X-PARTNER-ID: 00000000
X-EXTERNAL-ID: 1187412354
X-SIGNATURE: AaE7rxaiIFPQYryj+JxwOi826dQG4e8RbzagEBaAywS4ETa490Cy/3b1/Ljqput67EF+OgE0V1GDw2t/lxqEJw==
CHANNEL-ID: 95221
{
    "productType" : "bankva_dinamis",
    "productCategory" : "cash_in"
}

Response​

Body

Contoh Response

NoNameTypeLengthRequiredConditionRemarks
1responseCodeStringVariable, 7 maxWajib–Merujuk pada daftar kode respons.
2responseMessageStringVariable, 150 maxWajib–Merujuk pada daftar kode respons.
4detailDataArray of ObjectVariableWajib–Berisi array of object dari produk
5detailData.productCodeStringVariable, 20 maxOptional–Kode unik yang digunakan untuk mengidentifikasi suatu produk.
6detailData.productNameStringVariable, 100 maxOptional–Nama produk yang ditampilkan secara deskriptif untuk memudahkan pengguna dalam mengenali jenis produk atau layanan.
7detailData.productTypeString (Enum)Variable, 25 maxOptional–Jenis produk yang menunjukkan kelompok layanan
8detailData.productCategoryString (Enum)VariableOptional–Kategori utama produk yang digunakan untuk mengelompokkan produk berdasarkan jenis layanan atau fungsinya
9detailData.isMaintenanceBooleanVariableOptional–Menunjukkan status pemeliharaan produk. Bernilai true jika produk sedang dalam masa perbaikan atau tidak dapat digunakan sementara waktu, dan false jika produk tersedia untuk transaksi.
10detailData.priceStringVariableOptional–Menampilkan harga dari produk
11detailData.priceTypeString (Enum)VariableOptionalEnum value “fixed”, “percentage”Menampilkan tipe harga dari produk, berupa harga “fixed” (Rupiah) atau “percentage” (%)
{
    "responseCode": "2001300",
    "responseMessage": "Request has been processed successfully",
    "detailData": [
        {
            "productCode": "014",
            "productName": "VA BCA",
            "productType": "bankva_dinamis",
            "productCategory": "cash_in",
            "isMaintenance": false,
            "price": "0.3",
            "priceType": "percentage"
        },
        {
            "productCode": "147",
            "productName": "VA MUAMALAT",
            "productType": "bankva_dinamis",
            "productCategory": "cash_in",
            "isMaintenance": false,
            "price": "700",
            "priceType": "fixed"
        }
]

Kode dan Pesan Response

NoResponse KodeResponse PesanKeterangan
12001300SuccessfulRequest telah berhasil diproses tanpa ada masalah
24001301Invalid Field FormatPesan kesalahan yang menunjukkan bahwa format nilai pada salah satu field dalam request tidak sesuai dengan format yang diharapkan oleh sistem (misalnya tipe data, panjang karakter, atau pola tertentu).
34001302Invalid Wajib FieldKolom atau field yang wajib diisi tidak lengkap atau formatnya tidak sesuai dengan yang diharapkan
44011300Unauthorized. [reason]Kesalahan umum yang terjadi ketika pengguna atau sistem tidak memiliki izin untuk mengakses tindakan tertentu
54011301Invalid Token (B2B)Token akses yang digunakan untuk otentikasi tidak sah atau sudah kedaluwarsa
75001302Backend system failureKesalahan yang terjadi di server saat mencoba memproses request

Related Posts