Developers

Dokumentasi API

Tipzy API Key untuk cek Saldo, Payment Gateway, Transfer Saldo antar user, dan Disbursement (pencairan ke rekening). Saldo yang dipotong selalu milik pemilik API Key.

Buat API Key

Kelola key di Integrations → API.

Autentikasi

Sertakan API Key pada setiap request melalui header Authorization. Key hanya dapat digunakan dari alamat IP yang diizinkan jika kamu mengatur pembatasan IP saat membuat key.

Base URL

https://api.tipzy.id

Header (wajib)

Authorization: Bearer <api-key>

Header (disarankan)

User-Agent: <app-name>/1.0

Callback URL & Redirect URL

Diatur sekali di halaman API Key, berlaku otomatis untuk setiap pembayaran yang dibuat dengan key tersebut. Tidak dikirim sebagai body request.

Redirect URL

Ke mana pembayar diarahkan di halaman sukses setelah pembayaran berhasil. Kosongkan untuk memakai halaman Tipzy bawaan.

Callback URL

Tipzy mengirim satu kali HTTP POST ke URL ini (harus https://, tidak boleh alamat internal) setiap pembayaran sukses lewat key ini.

Contoh body callback

{
  "event": "payment.success",
  "data": {
    "id": "01HXYZ…",
    "status": "success",
    "amount": 50000,
    "payment_method": "qris",
    "payment_url": "https://tipzy.id/donation/transaction/01HXYZ…",
    "status_page_url": "https://tipzy.id/donation/transaction/01HXYZ…/status",
    "created_at": "2026-08-11T06:30:00.000Z",
    "paid_at": "2026-08-11T06:31:12.000Z",
    "payer_name": "Budi",
    "payer_email": "budi@email.com",
    "message": "Pembayaran order #123"
  }
}

Memvalidasi Callback

Apabila Callback Secret diisi, body callback ditandatangani dengan HMAC SHA-256 pada header X-Tipzy-Signature. Contoh di Node.js:

const crypto = require("crypto");

const computedSignature = crypto
  .createHmac("sha256", callbackSecret)
  .update(JSON.stringify(callbackBody))
  .digest("hex");

return crypto.timingSafeEqual(
  Buffer.from(computedSignature),
  Buffer.from(tipzySignatureFromHeader)
);

GET /api/v1/gateway/payment-channels

Metode Pembayaran

Daftar channel yang sedang diaktifkan platform (Tipzy). Create Transaction hanya menerima kode dari daftar ini. Jika platform mengaktifkan VA / e-wallet baru, channel tersebut otomatis muncul di sini dan bisa dipakai tanpa perubahan API.

Contoh request

curl https://api.tipzy.id/api/v1/gateway/payment-channels \
  -H "Authorization: Bearer <api-key>" \
  -H "User-Agent: MyApp/1.0"

Contoh response 200

{
  "success": true,
  "result": {
    "countries": [
      {
        "code": "ID",
        "label": "Indonesia",
        "currency": "IDR",
        "channels": [
          {
            "code": "QRIS",
            "label": "QRIS",
            "presentation": "qr",
            "payment_category": "qris",
            "requires_phone": false,
            "icon_url": "https://…/qris.svg"
          },
          {
            "code": "BCA_VIRTUAL_ACCOUNT",
            "label": "BCA Virtual Account",
            "presentation": "present",
            "payment_category": "bank_transfer",
            "requires_phone": false,
            "icon_url": "https://…/logo-bca.png"
          },
          {
            "code": "DANA",
            "label": "DANA",
            "presentation": "redirect",
            "payment_category": "ewallet",
            "requires_phone": true,
            "icon_url": "https://…/dana.svg"
          },
          {
            "code": "OVO",
            "label": "OVO",
            "presentation": "push",
            "payment_category": "ewallet",
            "requires_phone": true,
            "icon_url": "https://…/ovo.svg"
          }
        ]
      }
    ]
  }
}

presentation: qr (QRIS), present (VA / kode retail), redirect (e-wallet redirect, mis. DANA / GoPay / ShopeePay), push (e-wallet push, mis. OVO). payment_category: qris, ewallet, bank_transfer, retail.

Referensi kode channel (Indonesia / ID)

Pakai nilai kolom code sebagai payment_channel saat Create Transaction. Kolom Aktif mengikuti setting platform saat ini (★ = diaktifkan admin). Channel nonaktif tetap tercantum sebagai referensi kode, tapi Create Transaction akan menolaknya.

QRIS / QR

qris

QRIS

QRIS

presentation: qr

Code	Nama	Presentation	Phone	Aktif
QRIS	QRIS	qr	—	…

E-Wallet

ewallet

OVO

OVO

presentation: push · phone: wajib

DANA

DANA