Dokumentasi API & Integrasi

🔑 Autentikasi Kunci API (API Key)

Setiap permintaan ke seluruh endpoint /api/v2/* wajib menyertakan X-Api-Key pada header request. Dapatkan API Key unik Anda dari Dashboard User menu API & Webhook.

Header Autentikasi Wajib

X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

⚠️ Format & Kode Error

Jika terjadi kegagalan (misalnya API key salah, nominal tidak valid, atau rate limit terlampaui), server YNA PAY akan mengembalikan format error JSON standar.

Contoh Response Error (400 Bad Request) 400 ERROR

{
  "status": "error",
  "message": "Nominal pembayaran minimal Rp1.000."
}

POST /api/v2/qris/create

Membuat invoice baru dan menghasilkan QRIS Dinamis instan otomatis. Nominal amount adalah jumlah dana yang ingin Anda terima utuh.

Parameter Request (JSON Body)

Field	Tipe	Status	Deskripsi
amount	Number	Wajib	Nominal transaksi dalam Rupiah (contoh: `50000`).
note	String	Opsional	Catatan transaksi / nama produk (maksimal 200 karakter).
customer_name	String	Opsional	Nama pembeli / username pelanggan Anda.

curl -X POST https://api.ynapay.my.id/api/v2/qris/create \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx" \
  -d '{
    "amount": 50000,
    "note": "Pembelian Akun Premium #123",
    "customer_name": "Yuna"
  }'

const axios = require('axios');

async function createQris() {
  const response = await axios.post('https://api.ynapay.my.id/api/v2/qris/create', {
    amount: 50000,
    note: 'Pembelian Akun Premium #123',
    customer_name: 'Yuna'
  }, {
    headers: {
      'Content-Type': 'application/json',
      'X-Api-Key': 'yna-xxxxxxxxxxxxxxxxxxxx'
    }
  });

  console.log('QRIS String:', response.data.data.qr_string);
  console.log('Total Bayar:', response.data.data.total_amount);
}
createQris();

<?php
$payload = [
    "amount" => 50000,
    "note" => "Pembelian Akun Premium #123",
    "customer_name" => "Yuna"
];

$ch = curl_init("https://api.ynapay.my.id/api/v2/qris/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

echo "Ref No: " . $response['data']['ref_no'];
?>

import requests

url = "https://api.ynapay.my.id/api/v2/qris/create"
headers = {
    "Content-Type": "application/json",
    "X-Api-Key": "yna-xxxxxxxxxxxxxxxxxxxx"
}
payload = {
    "amount": 50000,
    "note": "Pembelian Akun Premium #123",
    "customer_name": "Yuna"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()
print("QRIS String:", data["data"]["qr_string"])

Contoh Response Sukses (200 OK) 200 SUCCESS

{
  "status": "success",
  "data": {
    "ref_no": "YNA-QR-20260826-87421",
    "amount": 50000,
    "fee": 350,
    "total_amount": 50350,
    "qr_string": "00020101021126570011ID.DANA.WWW0118936009153827135233...",
    "qr_image_url": "https://api.ynapay.my.id/api/v2/qris/image/YNA-QR-20260826-87421.png",
    "status": "PENDING",
    "expired_at": "2026-08-26T04:20:00.000Z"
  }
}

GET /api/v2/qris/status/:refNo

Mengecek status pembayaran QRIS terkini secara real-time berdasarkan nomor referensi transaksi (ref_no).

curl -X GET https://api.ynapay.my.id/api/v2/qris/status/YNA-QR-20260826-87421 \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"

const axios = require('axios');

async function checkStatus(refNo) {
  const response = await axios.get(`https://api.ynapay.my.id/api/v2/qris/status/${refNo}`, {
    headers: { 'X-Api-Key': 'yna-xxxxxxxxxxxxxxxxxxxx' }
  });
  console.log('Status:', response.data.data.status); // SUCCESS / PENDING / EXPIRED
}
checkStatus('YNA-QR-20260826-87421');

<?php
$refNo = "YNA-QR-20260826-87421";
$ch = curl_init("https://api.ynapay.my.id/api/v2/qris/status/" . $refNo);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"]);
$res = json_decode(curl_exec($ch), true);
curl_close($ch);

echo "Status Pembayaran: " . $res['data']['status'];
?>

Contoh Response Status Sukses 200 SUCCESS

{
  "status": "success",
  "data": {
    "ref_no": "YNA-QR-20260826-87421",
    "amount": 50000,
    "total_amount": 50350,
    "status": "SUCCESS",
    "paid_at": "2026-08-26T04:12:30.000Z",
    "customer_name": "Yuna",
    "created_at": "2026-08-26T04:05:00.000Z"
  }
}

GET /api/v2/transactions

Mengambil daftar seluruh riwayat transaksi merchant Anda dengan dukungan pagination (page & limit) serta filter status.

curl -X GET "https://api.ynapay.my.id/api/v2/transactions?page=1&limit=10&status=SUCCESS" \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"

const axios = require('axios');
const res = await axios.get('https://api.ynapay.my.id/api/v2/transactions?page=1&limit=10', {
  headers: { 'X-Api-Key': 'yna-xxxxxxxxxxxxxxxxxxxx' }
});
console.log('Total Transaksi:', res.data.data.length);

GET /api/v2/balance

Mengambil informasi saldo akun merchant Anda saat ini, termasuk saldo siap ditarik, saldo tertahan, dan total penarikan.

curl -X GET https://api.ynapay.my.id/api/v2/balance \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"

const axios = require('axios');
const res = await axios.get('https://api.ynapay.my.id/api/v2/balance', {
  headers: { 'X-Api-Key': 'yna-xxxxxxxxxxxxxxxxxxxx' }
});
console.log('Saldo Tersedia:', res.data.data.balance);

POST /api/v2/deposit

Membuat tagihan deposit saldo otomatis via QRIS. Dana langsung masuk ke saldo akun Anda seketika setelah pembayaran diselesaikan.

curl -X POST https://api.ynapay.my.id/api/v2/deposit \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx" \
  -d '{ "amount": 100000 }'

const axios = require('axios');
const res = await axios.post('https://api.ynapay.my.id/api/v2/deposit', {
  amount: 100000
}, {
  headers: { 'X-Api-Key': 'yna-xxxxxxxxxxxxxxxxxxxx' }
});
console.log('QRIS Deposit:', res.data.data.qr_string);

GET /api/v2/deposits

Melihat histori seluruh pengajuan top-up deposit saldo akun Anda beserta status pembayarannya.

cURL Request

curl -X GET https://api.ynapay.my.id/api/v2/deposits \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"

GET /api/v2/payment-channels

Mengambil daftar channel bank & e-wallet aktif yang tersedia untuk metode pencairan withdraw saldo merchant.

cURL Request

curl -X GET https://api.ynapay.my.id/api/v2/payment-channels \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"

PUT /api/v2/settings/callback-url

Mengubah atau mendaftarkan Callback Webhook URL tujuan yang akan menerima HTTP POST notifikasi otomatis saat pembayaran lunas.

cURL Request

curl -X PUT https://api.ynapay.my.id/api/v2/settings/callback-url \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx" \
  -d '{ "callback_url": "https://domain-anda.com/api/webhook" }'

GET /api/v2/webhook-logs

Mengambil histori log pengiriman notifikasi webhook ke server Anda lengkap dengan status HTTP response server Anda.

cURL Request

curl -X GET https://api.ynapay.my.id/api/v2/webhook-logs \
  -H "X-Api-Key: yna-xxxxxxxxxxxxxxxxxxxx"

🔔 Format Notifikasi Webhook Otomatis

Saat pelanggan Anda berhasil membayar QRIS, server YNA PAY akan secara instan mengirimkan notifikasi HTTP POST ke Callback URL yang Anda daftarkan di dashboard.

Payload Notifikasi Webhook yang Diterima Server Anda POST PAYLOAD

{
  "event": "PAYMENT_SUCCESS",
  "ref_no": "YNA-QR-20260826-87421",
  "amount": 50000,
  "total_amount": 50350,
  "status": "SUCCESS",
  "paid_at": "2026-08-26T04:12:30.000Z",
  "note": "Pembelian Akun Premium #123",
  "signature": "a6b7c8d9e0f1..."
}

💡 Tips Respon Webhook: Pastikan endpoint server Anda mengembalikan HTTP status 200 OK dengan body {"status":"OK"} agar sistem YNA PAY mencatat notifikasi berhasil terkirim.

Dokumentasi API YNA PAY

🔑 Autentikasi Kunci API (API Key)

⚠️ Format & Kode Error

Parameter Request (JSON Body)

🔔 Format Notifikasi Webhook Otomatis