Deskripsi

Melihat saldo API yang tersedia.

Endpoint

POST /ppob/saldo

Request JSON

Copy

{}

Response JSON

Copy

{
    "success": true,
    "balance":5000000
}

Laravel

Copy

$response=$client->balance()->get();

return response()->json($response);

PHP Native

Copy

$response=$client->balance()->get();

print_r($response);

Deskripsi

Mengambil daftar produk PPOB terbaru.

Endpoint

POST /products

Request JSON

Copy

{}

Response JSON

Copy

{
 "success":true,
 "data":[
   {
      "code":"PLN20",
      "name":"Token PLN 20.000",
      "price":20500,
      
   }
 ]
}

Laravel

Copy

$response=$client->products()->get();

return response()->json($response);

PHP Native

Copy

$response=$client->products()->get();

print_r($response);

Deskripsi

Digunakan oleh pemilik API untuk mengajukan deposit saldo PPOB ke server SimolawP. Endpoint ini tidak melakukan transaksi PPOB dan hanya membuat permohonan penambahan saldo.

Endpoint

POST /ppob/saldo/request

Parameter Request

Request JSON

Copy
{
    "amount":100000,
    "bank":"BCA"
}

Response JSON

Copy
{
    "success":true,
    "message":"Deposit request created.",
    "amount":100000,
    "bank":"BCA"
}

Laravel

Copy
$response = $client->deposit()->request([
    'amount' => 100000,
    'bank'   => 'BCA'
]);

return response()->json($response);

PHP Native

Copy
$response = $client->deposit()->request([
    'amount' => 100000,
    'bank'   => 'BCA'
]);

print_r($response);

Catatan

• Tidak mengurangi saldo API.
• Transfer dilakukan setelah request dibuat.
• Saldo akan masuk setelah diverifikasi administrator.

Deskripsi

Mengambil daftar rekening tujuan deposit yang tersedia.

Endpoint

GET /ppob/bank/list

Request JSON

Copy
{}

Response JSON

Copy
{
    "success":true,
    "data":[
        {
            "code":"BCA",
            "name":"Bank Central Asia"
        },
        {
            "code":"BRI",
            "name":"Bank Rakyat Indonesia"
        }
    ]
}

Laravel

Copy
$response = $client->bank()->list();

return response()->json($response);

PHP Native

Copy
$response = $client->bank()->list();

print_r($response);

Deskripsi

Melakukan pengecekan tagihan pelanggan sebelum pembayaran.

Endpoint

POST /ppob/inquiry

Parameter Request

Request JSON

Copy

{
   
    "produk":"PLNPASCA",
    "idpel":"1234567890"
}

Response JSON

Copy

{
    "status":"success",
    "nama":"BUDI",
    "tagihan":152500,
    "ref1":"TRX000001"
}

Laravel

Copy

$response = $client->inquiry()->send([
    
    'produk'  => 'PLNPASCA',
    'idpel'   => '1234567890'
]);

PHP Native

Copy

$response = $client->inquiry()->send([
    
    'produk'  => 'PLNPASCA',
    'idpel'   => '1234567890'
]);

print_r($response);

Deskripsi

Melakukan inquiry pembelian Token PLN Prabayar.

Endpoint

POST /ppob/inquiry

Request JSON

Copy

{
    
    "produk":"PLNPRA",
    "idpel":"1234567890",
    "nominal":100000
}

Response JSON

Copy

{
    "status":"success",
    "nama":"BUDI",
    "ref1":"TRX000002"
}

Laravel

Copy

$response = $client->inquiry()->send([
    
    'produk'  => 'PLNPRA',
    'idpel'   => '1234567890',
    'nominal' => 100000
]);

PHP Native

Copy

$response = $client->inquiry()->send([
   
    'produk'  => 'PLNPRA',
    'idpel'   => '1234567890',
    'nominal' => 100000
]);

print_r($response);

Deskripsi

Melakukan pembayaran tagihan setelah proses Inquiry berhasil dilakukan. Gunakan nilai ref1 yang diperoleh dari endpoint Inquiry.

Endpoint

POST /ppob/payment

Parameter Request

Request JSON

Copy
{
 
    "produk":"PLNPASCA",
    "idpel":"1234567890",
    "nominal":152500,
    "ref1":"TRX000001",
    "type":"tagihan"
}

Response JSON

Copy
{
    "status":"success",
    "message":"Transaction Process"
}

Laravel

Copy
$response = $client->payment()->send([
    
    'produk'  => 'PLNPASCA',
    'idpel'   => '1234567890',
    'nominal' => 152500,
    'ref1'    => 'TRX000001',
    
]);

return response()->json($response);

PHP Native

Copy
$response = $client->payment()->send([
    
    'produk'  => 'PLNPASCA',
    'idpel'   => '1234567890',
    'nominal' => 152500,
    'ref1'    => 'TRX000001',
    
]);

print_r($response);

Deskripsi

Melakukan pembelian Token PLN Prabayar menggunakan hasil Inquiry.

Endpoint

POST /ppob/payment

Request JSON

Copy
{
    
    "produk":"PLNPRA",
    "idpel":"1234567890",
    "nominal":100000,
    "ref1":"TRX000002",
    "type":"token"
}

Response JSON

Copy
{
    "status":"success",
    "message":"Transaction Process"
}

Laravel

Copy
$response = $client->payment()->send([
    
    'produk'  => 'PLNPRA',
    'idpel'   => '1234567890',
    'nominal' => 100000,
    'ref1'    => 'TRX000002',
    'type'    => 'token'
]);

PHP Native

Copy
$response = $client->payment()->send([
    
    'produk'  => 'PLNPRA',
    'idpel'   => '1234567890',
    'nominal' => 100000,
    'ref1'    => 'TRX000002',
    'type'    => 'token'
]);

print_r($response);

Endpoint

POST /ppob/payment

Request JSON

Copy
{
  
    "produk":"TSEL10",
    "idpel":"081234567890",
    "ref1":"TRX000004",
    "type":"pulsa"
}

Response JSON

Copy
{
    "status":"success",
    "message":"Transaction Process"
}

Laravel

Copy
$response = $client->payment()->send([
    
    'produk'  => 'TSEL10',
    'idpel'   => '081234567890',
    'ref1'    => 'TRX000004',
    'type'    => 'pulsa'
]);

PHP Native

Copy
$response = $client->payment()->send([
    
    'produk'  => 'TSEL10',
    'idpel'   => '081234567890',
    'ref1'    => 'TRX000004',
    'type'    => 'pulsa'
]);

print_r($response);

Deskripsi

Digunakan untuk mengetahui status terbaru transaksi berdasarkan nomor referensi (ref1).

Endpoint

GET /ppob/status

Parameter Request

Request JSON

Copy
{
    "ref1":"TRX000001"
}

Response JSON

Copy
{
    "status":"SUCCESS",
    "sn":"123456789",
    "token":"1234-5678-9012-3456"
}

Keterangan Field

Laravel

Copy
$response = $client->status()->get([
    'ref1' => 'TRX000001'
]);

return response()->json($response);

PHP Native

Copy
$response = $client->status()->get([
    'ref1' => 'TRX000001'
]);

print_r($response);

Method

POST

Content Type

Copy

Content-Type: application/json

Authentication

Callback Body

Copy

{
    "ref1":"TRX000001",
    "status":"SUCCESS",
    "nominal":152500,
    "note":{
        "wp_user_id":1
    },
    "signature":"9c6a0d4d4f1bxxxxxxxxxxxxxxxxxxxxxxxx"
}

Keterangan Field

Payload Signature

Signature dibuat menggunakan algoritma HMAC SHA256 dengan payload berikut.

Copy

{
    "ref1":"TRX000001",
    "status":"SUCCESS",
    "nominal":152500
}

Laravel Validation

Copy

$payload = [

    'ref1'    => $request->ref1,

    'status'  => $request->status,

    'nominal' => $request->nominal,

];

$signature = hash_hmac(

    'sha256',

    json_encode($payload),

    env('WP_CALLBACK_SECRET')

);

if($signature !== $request->signature){

    return response()->json([

        'status'=>'error',

        'message'=>'Invalid Signature'

    ],403);

}

Response Website

Website wajib mengembalikan HTTP Status 200 OK apabila Callback berhasil diproses.

Copy

{
    "success":true
}

Status Callback

Catatan

• Callback dikirim otomatis ketika status transaksi berubah.
• Callback tidak menggunakan API Key maupun Secret Key.
• Pastikan URL Callback dapat diakses melalui HTTPS.
• Selalu lakukan validasi Signature sebelum memproses transaksi.
• Simpan ref1 sebagai referensi utama transaksi.
• Apabila Website tidak merespon HTTP 200, server dapat mengirim ulang Callback sesuai kebijakan retry.

Tagihan (PLN Pascabayar, PDAM, BPJS, dll)

1. Login Website
        │
        ▼
2. Inquiry
        │
        ▼
3. Mendapat ref1
        │
        ▼
4. Payment
        │
        ▼
5. Status
        │
        ▼
6. Callback
        │
        ▼
7. Transaksi Selesai

Token PLN

Inquiry
     │
     ▼
Payment
     │
     ▼
Status
     │
     ▼
Callback

Pulsa & Paket Data

Payment
    │
    ▼
Status
    │
    ▼
Callback

• Simpan API Key dan Secret Key pada file environment (.env).
• Gunakan HTTPS pada seluruh endpoint.
• Selalu lakukan Inquiry sebelum Payment untuk produk tagihan.
• Gunakan nilai ref1 sebagai referensi utama transaksi.
• Jangan mengirim Payment dua kali dengan ref1 yang sama.
• Gunakan Callback sebagai sumber status transaksi yang paling valid.
• Lakukan validasi Signature pada Callback sebelum memproses data.
• Simpan seluruh request dan response sebagai log transaksi.
• Gunakan endpoint Status apabila Callback belum diterima.
• Batasi request menggunakan Rate Limiter.

• Jangan membagikan API Key kepada pihak lain.
• Secret Key hanya boleh digunakan pada sisi server.
• Seluruh request harus menggunakan Signature HMAC SHA256.
• Gunakan Timestamp untuk mencegah Replay Attack.
• Batasi IP Address apabila memungkinkan.
• Gunakan HTTPS/TLS.
• Verifikasi seluruh Callback menggunakan Signature.