FQrisDocs
SitusStatus
POST/v1/paymentsscope payments:write

Buat payment

Membuat payment baru dengan QRIS dinamis. FQris menambahkan kode unik 1–499 ke amount dan mengembalikan final_amount, qris.string, dan checkout_url.

Header

AuthorizationBearer <api_key>wajib
fq_live_… atau fq_test_…; mode ditentukan oleh key.
Idempotency-Keystring ≤ 255
Disimpan 24 jam. Body sama → respons sama; body beda → 409 IDEMPOTENCY_KEY_REUSED.
Content-Typeapplication/jsonwajib
JSON UTF-8.

Body

amountintegerwajib
Nominal dasar dalam rupiah bulat, Rp1.000–Rp5.000.000. Kode unik ditambahkan otomatis.
reference_idstring
ID pesanan di sistemmu. Unik per project + mode; duplikat mengembalikan 409.
descriptionstring
Tampil di halaman bayar dan struk, mis. "Top up 200 koin".
expiry_minutesintegerdefault 15
Masa berlaku 5–60 menit. Setelah itu ada cooldown 30 menit untuk pembayaran terlambat.
customerobject
Data pembeli opsional untuk struk dan riwayat.
namestring
Nama pembeli
emailstring
Email untuk struk
phonestring
Format 62…
metadataobject
Maks 20 key; dikembalikan apa adanya di semua webhook.
{key}string ≤ 500
Key ≤ 40 karakter, mis. user_id, coin_package
return_urlstring
Tujuan tombol "Kembali" setelah sukses. Jangan dipakai untuk mengkredit.
cancel_urlstring
Tujuan saat pembeli membatalkan.
source_idstring
Override strategi pemilihan QRIS source project.
checkoutobject
Opsi halaman bayar.
allow_retryboolean
Tampilkan "Buat pembayaran baru" saat kedaluwarsa
localeid | en
Bahasa default halaman bayar
send_receipt_emailbooleandefault pengaturan project
Kirim struk ke customer.email saat paid.

Respons

201Payment dibuat. Objek Payment lengkap.
400Validasi gagal: AMOUNT_TOO_LOW, AMOUNT_TOO_HIGH, INVALID_EXPIRY…402SUBSCRIPTION_INACTIVE409DUPLICATE_REFERENCE, NO_AVAILABLE_SLOT, IDEMPOTENCY_KEY_REUSED503NO_HEALTHY_SOURCE (live, perilaku block)
1import FQris from '@fqris/node';
2const fqris = new FQris(process.env.FQRIS_KEY);
3
4const payment = await fqris.payments.create({
5 amount: 20000,
6 reference_id: 'TOPUP-88812',
7});
8console.log(payment.checkout_url);
201Payment
1{
2 "id": "pay_01JA2Z3K8M",
3 "object": "payment",
4 "mode": "test",
5 "status": "pending",
6 "base_amount": 20000,
7 "unique_code": 137,
8 "final_amount": 20137,
9 "currency": "IDR",
10 "reference_id": "TOPUP-88812",
11 "qris": {
12 "string": "00020101021226…6304A1B2",
13 "merchant_name": "TOKO UCUY"
14 },
15 "checkout_url": "https://pay.fqris.id/p/ck_8f2…",
16 "expires_at": "2026-10-14T05:55:00Z",
17 "created_at": "2026-10-14T05:40:00Z"
18}
Apakah halaman ini membantu?