REST API v1 Reference
Dokumentasi Integrasi Ave Payment
Integrasikan bot Telegram, platform otomatisasi, atau toko online Anda ke gateway pembayaran QRIS otomatis yang ditenagai Cloudflare Workers berkinerja tinggi.
1
Ikhtisar & Autentikasi
Semua permintaan REST API dikirimkan via HTTPS ke base URL resmi:
https://avepayment.my.id/v1HTTPS Encrypted
Setiap endpoint membutuhkan header Authorization dengan format Bearer Token yang dapat Anda buat di dashboard menu API Keys.
Authorization: Bearer ave_sec_xxxxxxxxxxxxxxxxxxxx
2
Buat Tagihan QRIS Dinamis
POST/v1/payments
| Field | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| outletId | string | Ya | ID outlet/toko Shopee Anda. |
| amount | number | Ya | Nominal dasar pembayaran (min. Rp500). |
| reference | string | Opsional | Kode unik referensi dari sistem Anda (misal: ID order). |
| expiresInMs | number | Opsional | Masa berlaku tagihan dalam ms (default: 900.000 ms / 15 menit). |
Contoh Response Berhasil (201 Created):
{
"id": "pay_9a8b7c6d5e",
"baseAmount": 15000,
"uniqueAmount": 15023,
"status": "pending",
"qrString": "00020101021226670016ID.CO.SHOPEE.WWW01189360091800000000000215ID102002131234565204581253033605802ID5911AVE PAYMENT6013JAKARTA BARAT61051147062070703A016304ABCD",
"expiresAt": "2026-10-10T14:15:00.000Z"
}3
Cek Status Tagihan
GET/v1/payments/:id
{
"id": "pay_9a8b7c6d5e",
"uniqueAmount": 15023,
"status": "paid",
"paidAt": "2026-10-10T14:02:15.000Z"
}4
Webhook Notifikasi Real-Time
Ketika pembayaran terkonfirmasi, server Ave Payment akan mengirimkan HTTP POST secara otomatis ke endpoint server atau bot Anda.
Payload Webhook Event (payment.paid):
{
"event": "payment.paid",
"timestamp": 1791640330,
"data": {
"id": "pay_9a8b7c6d5e",
"reference": "TOPUP-1791640200",
"amount": 15000,
"uniqueAmount": 15023,
"status": "paid",
"paidAt": "2026-10-10T14:02:15.000Z"
}
}5
Contoh Script Integrasi (cURL & Python)
cURL:
curl -X POST https://avepayment.my.id/v1/payments \
-H "Authorization: Bearer ave_sec_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"outletId": "out_YOUR_OUTLET_ID",
"amount": 25000,
"reference": "ORDER-001"
}'Python Client:
from avepayment_gateway import AvePaymentGateway
gateway = AvePaymentGateway(
api_key="ave_sec_YOUR_API_KEY",
outlet_id="out_YOUR_OUTLET_ID"
)
# 1. Buat tagihan QRIS
invoice = gateway.create_invoice(amount=25000)
print("QR String:", invoice["qr_string"])
print("Total Bayar:", invoice["total"])
# 2. Cek status
status = gateway.check_status(invoice["invoice_id"])
print("Status Pembayaran:", status["status"])6
Daftar Kode Error & HTTP Status
| HTTP Status | Pesan Error | Keterangan |
|---|---|---|
| 401 Unauthorized | INVALID_API_KEY | Token API Key tidak valid atau tidak dikirimkan. |
| 400 Bad Request | INVALID_AMOUNT | Nominal di bawah batas minimum (Rp500). |
| 503 Service Unavailable | OUTLET_OFFLINE | Sesi merchant Shopee terputus. Buka menu Akun Shopee di dashboard. |