Gerbang Pay

Indonesia

English

Indonesia

English

Appearance

Quickstart ​

Panduan singkat ini akan menunjukkan cara Anda dapat menerima pembayaran pertama menggunakan Gerbang Pay dalam waktu kurang dari 5 menit, dengan menggunakan Virtual Account BCA.

Langkah 1: Persiapan di Dashboard ​

Sebelum menyentuh kode, pastikan konfigurasi dasar Anda sudah siap.

  1. Buka Dashboard Gerbang Pay
  2. Masuk ke Integration Setup dan generate Test API Key. (Simpan key yang diawali dengan gp_test_...)
  3. Masukkan kredensial provider (misalnya Winpay) di menu Provider Setup. (Anda dapat menggunakan test credential).
  4. Masuk ke Routing Rules dan atur agar metode pembayaran Virtual Account (Semua Bank) diarahkan (routed) ke Winpay.
  5. Opsional: Set Webhook URL di menu Integration Setup jika Anda sudah memiliki server yang bisa diakses (misal via Ngrok).

Langkah 2: Tes Koneksi (Get Active Methods) ​

Mari pastikan API Key dan Routing Rule Anda sudah bekerja. Panggil endpoint GET /v1/active-methods. Endpoint ini akan mengembalikan daftar metode yang telah Anda konfigurasi.

bash
curl -X GET https://gerbang-pay-api.gai.co.id/v1/active-methods \
  -H "Authorization: ApiKey gp_test_xxxxxxxxxxxx"

Jika sukses, Anda akan melihat JSON yang menyatakan Winpay aktif dengan metode Virtual Account di dalamnya. Ini berarti Gerbang Pay siap menerima request pembayaran.

Langkah 3: Create Payment ​

Kita akan membuat transaksi penagihan (charge) sebesar Rp 100.000 (yang mana diisi dengan format sen: 10000000).

bash
curl -X POST https://gerbang-pay-api.gai.co.id/v1/payments/create \
  -H "Authorization: ApiKey gp_test_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: order-quickstart-001" \
  -d '{
    "amount": 10000000,
    "currency": "IDR",
    "method_type": "virtual_account",
    "method_detail": {
      "type": "virtual_account",
      "bank": "BCA"
    },
    "customer_name": "Budi Quickstart",
    "customer_phone": "081234567890",
    "expiry_minutes": 60
  }'

Response sukses (200 OK): Anda akan mendapatkan balasan berisi payment_code, ID transaksi (id), dan yang terpenting: nomor Virtual Account yang harus dibayar pada bagian method_data.va_number.

json
{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "pending",
    "method_data": {
      "type": "virtual_account",
      "bank": "BCA",
      "va_number": "88880123456"
    }
  }
}

Langkah 4: Simulasikan Pembayaran ​

Karena kita menggunakan Test Key (gp_test_...), tidak ada uang sungguhan yang ditransfer. Untuk membuat status transaksi menjadi "Paid", kita gunakan simulator.

  1. Kembali ke Dashboard Gerbang Pay.
  2. Buka menu Sandbox Simulator.
  3. Anda akan melihat transaksi order-quickstart-001 Anda di sana berstatus pending.
  4. Klik tombol Simulate Payment.
  5. Sistem internal Gerbang Pay akan menandai transaksi tersebut lunas seolah-olah Budi Quickstart baru saja mentransfer uang ke VA BCA-nya.

Langkah 5: Cek Status / Terima Webhook ​

Jika Anda sebelumnya sudah mendaftarkan Webhook URL di Langkah 1, periksa log server Anda. Anda seharusnya sudah menerima request POST webhook dari Gerbang Pay bertuliskan payment.paid.

Jika belum menggunakan webhook, Anda bisa mem-polling statusnya:

bash
curl -X GET https://gerbang-pay-api.gai.co.id/v1/payments/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: ApiKey gp_test_xxxxxxxxxxxx"

Anda akan melihat status sudah berubah menjadi paid dan field paid_at terisi dengan waktu pembayaran.

Selamat! Anda berhasil menyelesaikan transaksi Gerbang Pay pertama Anda.

Gerbang Pay API Documentation