Dokumentasi API
Panduan lengkap untuk mengintegrasikan TokogarPay ke dalam aplikasi Anda.
Profil Pengguna
Dapatkan detail profil pengguna saat ini. Endpoint ini memerlukan API Key.
POST
/api/profile
POST https://api.tokogar.com/api/profile
Headers:
Content-Type: application/x-www-form-urlencoded
Contoh Response (200 OK)
{
"success": true,
"message": "Profile retrieved successfully",
"data": {
"id": "usr_8723",
"name": "TokogarPay",
"email": "tokogarpay@example.com",
"merchant_id": "mch_9921"
}
}
Buat Pesanan
Buat pesanan pembayaran baru. Anda akan mendapatkan URL pembayaran atau instruksi Virtual Account.
POST
/api/order
| Field | Tipe | Deskripsi |
|---|---|---|
| api_key | string | API Key merchant Anda. |
| ref_id | string | ID Referensi unik order Anda. |
| method_id | string | ID Metode pembayaran. |
| amount | integer | Jumlah pembayaran (IDR). |
| fee_type | integer | Tipe biaya (1: Merchant, 2: Customer). |
| note | string | Catatan transaksi. |
| redirect_url | string | URL redirect setelah pembayaran. |
| callback_url | string | URL Callback untuk notifikasi. |
Field
Tipe
Deskripsi
amount
integer
Jumlah pembayaran (IDR).
Field
Tipe
Deskripsi
method
string
Kode metode (misal: 'va_bca').
Field
Tipe
Deskripsi
items
array
Daftar item pembelian.
{
"success": true,
"message": "Order created successfully",
"data": {
"pay_id": "TGP2601102JHRHG",
"ref_id": "test020",
"checkout_url": "https://payment.tokogar.com/invoice/TGP123***",
"method": "QRIS",
"amount": 10000,
"fee": 0,
"additional_fee": 0, // Khusus untuk non mitra tokogar
"total_amount": 10000,
"received_amount": 10000,
"expired_at": "2026-02-06 23:26:10",
"payment_data": {
"type": "QRIS",
"qris_content_static": "00020101021226590013ID.CX.PROD...",
"qris_content_dynamic": "00020101021226590013ID.CX.PROD...",
"qris_url_static": "https://payment.tokogar.com/qris/.....",
"qris_url_dynamic": "https://payment.tokogar.com/qris/....."
},
"status": "Pending"
}
}
Cek Status
Lihat status transaksi berdasarkan ID referensi pesanan.
POST
/api/status
POST https://api.tokogar.com/api/status
Headers:
Content-Type: application/x-www-form-urlencoded
Contoh Response (200 OK)
{
"success": true,
"message": "Order status retrieved",
"data": {
"pay_id": "TGP2601102JHRHG",
"ref_id": "test002",
"method": "BCA Transfer",
"amount": 10000,
"fee": 0,
"total_amount": 10000,
"received_amount": 10000,
"status": "Paid"
}
}
Callback / Webhooks
Kami akan mengirimkan HTTP POST ke URL callback Anda setiap kali status pembayaran berubah.
POST
/callback_url_anda
| Field | Tipe | Deskripsi |
|---|---|---|
| pay_id | string | ID Transaksi Tokogar. |
| ref_id | string | ID Referensi order Anda. |
| status | string | Status pembayaran (e.g. 'Paid'). |
| amount | integer | Jumlah pembayaran. |
Field
Tipe
Deskripsi
status
string
'paid', 'expired', atau 'failed'.
Field
Tipe
Deskripsi
reference_id
string
ID untuk pesanan Anda.
Field
Tipe
Deskripsi
signature
string
Untuk verifikasi keamanan.
Respon yang Diharapkan dari Server Anda
{
"status": "ok"
}