เอกสาร API

เริ่มต้นใช้งาน

1. ขอสิทธิ์เข้าใช้งาน (ขณะนี้เราอยู่ในช่วงเบต้าแบบปิด บัญชีจะเปิดผ่านคำเชิญของคุณ) แล้วสร้างร้านค้า จากนั้นเปิดใช้การยืนยันตัวตนสองขั้นตอน (2FA)
2. เปิดแท็บ API ของร้านค้าแล้วสร้างคีย์ลับ (Secret key) หากต้องการ สามารถอนุญาตเฉพาะ IP ของเซิร์ฟเวอร์คุณได้
3. ตั้งค่า Status URL ของร้านค้า: เราจะส่ง POST ไปยัง URL นี้ทุกครั้งที่ใบแจ้งหนี้มีการเปลี่ยนแปลง
4. สร้างใบแจ้งหนี้จากเซิร์ฟเวอร์ของคุณ แล้วพาลูกค้าไปยัง invoice_url ที่ได้รับกลับมา

ทุกการตอบกลับอยู่ในรูปแบบ JSON: { "status": "success", "data": { … } } หรือ { "status": "error", "data": { "code": 103, "message": "…" } }

Invoices

curl -G "https://api.aywapay.com/api/v1/invoices/new" \
  -d source_currency=USD -d source_amount=49.99 \
  -d order_number=1042 --data-urlencode "order_name=Pro plan" \
  --data-urlencode "callback_url=https://yourshop.com/callback?json=true" \
  -d api_key=$AYWAPAY_SECRET_KEY

{
  "txn_id": "65f1c0ffee00000000000001",
  "invoice_url": "https://pay.aywapay.com/invoice/65f1c0ffee00000000000001",
  "invoice_total_sum": "0.5512"
}

curl -G "https://api.aywapay.com/api/v1/invoices/:id" -d api_key=$AYWAPAY_SECRET_KEY

{
  "invoice": { "txn_id": "…", "status": "completed", "psys_cid": "LTC",
    "amount": "0.5512", "received_amount": "0.5512",
    "remaining_amount": "0", "wallet_hash": "ltc1q…",
    "expected_confirmations": 6, "tx_url": ["…"], "tx_id": ["…"] },
  "active_invoice_id": "…"
}

Withdrawals & payouts

curl -G "https://api.aywapay.com/api/v1/operations/withdraw" -d api_key=$AYWAPAY_SECRET_KEY

{ "id": "65f1c0ffee00000000000002", "type": "cash_out", "status": "pending",
  "psys_cid": "USDT_TRX", "currency": "USDT", "amount": "25.00", "fee": "1.25",
  "wallet_hash": "T…", "tx_url": "", "tx_id": [] }

curl -G "https://api.aywapay.com/api/v1/operations/fee/:psys_cid" -d api_key=$AYWAPAY_SECRET_KEY

{ "fee": "0.0000021", "psys_cid": "LTC", "currency": "LTC", "plan": "normal" }

curl -G "https://api.aywapay.com/api/v1/operations/commission/:psys_cid" -d api_key=$AYWAPAY_SECRET_KEY

{ "commission": "0", "fee": "0.0000021", "feeUnit": "LTC", "plan": "normal",
  "plans": { "normal": { "value": "0.0000021" }, "priority": { "value": "0.0000042" } } }

curl -G "https://api.aywapay.com/api/v1/operations/fee-plan/:psys_cid" -d api_key=$AYWAPAY_SECRET_KEY

{ "normal": { … }, "priority": { … } }

Balances, operations & coins

curl -G "https://api.aywapay.com/api/v1/balances/:psys_cid" -d api_key=$AYWAPAY_SECRET_KEY

{ "psys_cid": "LTC", "currency": "LTC", "balance": "0.0510" }

curl -G "https://api.aywapay.com/api/v1/operations" -d api_key=$AYWAPAY_SECRET_KEY

{ "operations": [ … ], "_meta": { "totalCount": 3, "pageCount": 1, "currentPage": 1, "perPage": 10 } }

curl -G "https://api.aywapay.com/api/v1/operations/:id" -d api_key=$AYWAPAY_SECRET_KEY

{ "id": "…", "type": "invoice", "status": "completed", … }

curl -G "https://api.aywapay.com/api/v1/currencies/:fiat" -d api_key=$AYWAPAY_SECRET_KEY

[ { "cid": "BTC", "name": "Bitcoin", "rate_usd": "0.0000125", "min_sum_in": "0.0001", "min_withdraw": "0.0002", … } ]

curl -G "https://api.aywapay.com/api/v1/shops" -d api_key=$AYWAPAY_SECRET_KEY

{ "id": "…", "name": "My Shop", "plan": "api", … }

Deposit addresses (White Label)

curl -G "https://api.aywapay.com/api/v1/shops/deposit/new" -d api_key=$AYWAPAY_SECRET_KEY

{ "psys_cid": "USDT_TRX", "uid": "user-17", "hash": "T…" }

curl -G "https://api.aywapay.com/api/v1/shops/deposit" -d api_key=$AYWAPAY_SECRET_KEY

[ { "psys_cid": "BTC", "uid": "user-17", "hash": "bc1q…" } ]

Callback (Webhook)

On every invoice status change we POST the invoice to its callback_url (or the store's Status URL). Withdrawals made with your API key are reported to the Status URL too, when they are sent, completed, fail or are cancelled. Add ?json=true to the URL to get JSON instead of a form post.

• Answer with HTTP 200. Anything else is retried 8 more times over about two days, then shown as Failed in your dashboard.
• Always check verify_hash before trusting a callback.
• Stores & API → Webhooks shows every attempt, lets you resend one, and sends a signed test.

{
  "txn_id": "65f1c0ffee00000000000001",
  "ipn_type": "invoice",
  "merchant": "My Shop",
  "merchant_id": "3f2a9c1e-…",
  "status": "completed",
  "amount": "0.5512",
  "currency": "LTC",
  "order_number": "1042",
  "order_name": "Pro plan",
  "confirmations": "6",
  "source_currency": "USD",
  "source_amount": "49.99",
  "invoice_total_sum": "0.5512",
  "verify_hash": "…"
}

{
  "txn_id": "65f1c0ffee00000000000002",
  "ipn_type": "cash_out",
  "merchant": "My Shop",
  "merchant_id": "3f2a9c1e-…",
  "status": "completed",          // pending | completed | error | cancelled
  "psys_cid": "USDT_TRX",
  "currency": "USDT",
  "amount": "25.00",
  "fee": "1.25",
  "to": "T…",
  "tx_id": "a1b2…",
  "comment": "",
  "verify_hash": "…"
}

ตรวจสอบลายเซ็น

verify_hash is an HMAC-SHA1 with your store's secret key: of PHP's serialize() of the key-sorted fields for form posts, or of JSON.stringify of the body without verify_hash for JSON.

<?php
// Your store's secret key (Stores & API → API)
$secretKey = getenv('AYWAPAY_SECRET_KEY');

$post = $_POST;                       // form-encoded callback
$received = $post['verify_hash'] ?? '';
unset($post['verify_hash']);
ksort($post);
$expected = hash_hmac('sha1', serialize($post), $secretKey);

if (!hash_equals($expected, $received)) {
    http_response_code(400);
    exit('bad signature');
}
if ($post['status'] === 'completed' || $post['status'] === 'mismatch') {
    // mark order $post['order_number'] as paid
}
http_response_code(200);

import crypto from "node:crypto";

// callback_url ends with ?json=true, so the body is JSON
app.post("/callback", express.json(), (req, res) => {
  const { verify_hash, ...body } = req.body;
  const expected = crypto
    .createHmac("sha1", process.env.AYWAPAY_SECRET_KEY)
    .update(JSON.stringify(body))
    .digest("hex");
  const given = Buffer.from(String(verify_hash ?? ""));
  const wanted = Buffer.from(expected);
  if (given.length !== wanted.length || !crypto.timingSafeEqual(given, wanted)) {
    return res.status(400).send("bad signature");
  }

  if (body.status === "completed" || body.status === "mismatch") {
    // mark order body.order_number as paid
  }
  res.sendStatus(200);
});

โหมดทดสอบ (Sandbox)

Every store can have a test key next to its live key (Stores & API → API → Test key). It works with the same endpoints, with no real money:

• Invoices made with the test key are test invoices: no deposit address, nothing on a blockchain.
• Their payment page has Simulate buttons: paid, overpaid, underpaid, expire. Each fires your normal callback, with test=true and signed with the test key.
• Test invoices never touch your balance. Withdrawals and deposit addresses need the live key (error 229); balances read 0.
• Order numbers are separate: a test order never blocks a live one with the same number.

curl -G "https://api.aywapay.com/api/v1/invoices/new" \
  -d source_currency=USD -d source_amount=10 \
  -d order_number=test-1 -d order_name=Test \
  -d api_key=$AYWAPAY_TEST_KEY

โดเมนชำระเงินของคุณเอง (ไวท์เลเบล)

ในแพ็กเกจไวท์เลเบล ใบแจ้งหนี้ ลิงก์ชำระเงิน หน้ารับบริจาค และปุ่มชำระเงินของคุณสามารถเปิดบนที่อยู่ของคุณเอง เช่น pay.yourshop.com แทนที่อยู่ของเรา ลูกค้าจะเห็นเฉพาะโดเมนและแบรนด์ของคุณ ใช้เพียงเรคคอร์ด DNS เดียวและเวลาประมาณสิบนาที โดยไม่ต้องใช้นักพัฒนา

วิธีตั้งค่า

1. เปลี่ยนร้านค้าเป็นแพ็กเกจไวท์เลเบล (ร้านค้า → ทั่วไป)
2. เปิดแท็บหน้าชำระเงินของร้านค้า ในส่วน “ลิงก์ชำระเงินเปิดที่ใด” ให้เลือกโดเมนของฉันเอง
3. พิมพ์ซับโดเมนที่คุณเป็นเจ้าของ เช่น pay.yourshop.com (ไม่ใช่ yourshop.com เอง) หากมีค่าธรรมเนียมแสดงอยู่ ให้อ่านก่อน แล้วกดบันทึก
4. คัดลอกเรคคอร์ดที่แสดงบนหน้าจอ แล้วเพิ่มในที่ที่คุณจัดการ DNS ของโดเมน (Cloudflare, GoDaddy, Namecheap, Hostinger และอื่น ๆ) แดชบอร์ดมีคู่มือสั้น ๆ สำหรับแต่ละที่
5. รอสักครู่ เราตรวจสอบทุกนาที: DNS → ใบรับรอง HTTPS → ใช้งานได้ โดยปกติใช้เวลา 5 ถึง 30 นาที แต่เรคคอร์ด DNS ใหม่อาจใช้เวลาหลายชั่วโมง เราจะส่งอีเมลแจ้งเมื่อใช้งานได้

เรคคอร์ด DNS

คัดลอกปลายทางที่ถูกต้องจากแดชบอร์ดของคุณ เพราะเป็นค่าเฉพาะของร้านค้าคุณ ผู้ให้บริการส่วนใหญ่ต้องการแค่ส่วนแรก (pay) เป็นชื่อ

หากการตรวจสอบไม่ผ่าน

• ไม่พบเรคคอร์ด: ยังไม่มี CNAME หรือ DNS ยังกระจายไม่ทั่ว ตรวจสอบชื่อแล้วรอสักครู่
• ชี้ไปที่อื่น: มีเรคคอร์ดอื่น (A, AAAA หรือ CNAME เก่า) ใช้ชื่อเดียวกัน ให้ลบออกและเหลือไว้เฉพาะ CNAME
• ผ่านพร็อกซี: เมฆสีส้มของ Cloudflare เปิดอยู่ ให้เปลี่ยนเรคคอร์ดเป็น “DNS only”
• รอใบรับรอง: DNS ถูกต้องแล้ว และใบรับรอง HTTPS มักจะตามมาภายในไม่กี่นาที

เมื่อใช้งานได้แล้ว

• ลิงก์ใหม่และลิงก์เดิมจะเปิดบนโดเมนของคุณ ลิงก์ที่ส่งไปแล้วด้วยที่อยู่ของเรายังใช้งานได้ตามปกติ
• คุณกลับไปใช้ลิงก์ AywaPay ได้ทุกเมื่อด้วยคลิกเดียว และโดเมนของคุณจะยังบันทึกไว้
• หาก DNS ของคุณไม่ได้ชี้มาที่เรานาน 24 ชั่วโมง ลิงก์จะกลับไปใช้ที่อยู่ของเราเองโดยอัตโนมัติ และเราจะส่งอีเมลแจ้งคุณ จึงไม่มีการชำระเงินใดสูญหาย
• หากบัญชีของคุณมีค่าธรรมเนียมสำหรับโดเมนของคุณเอง ค่าธรรมเนียมจะแสดงก่อนบันทึก และหักจากยอดคงเหลือของคุณ

ไม่เห็นตัวเลือกนี้ใช่ไหม? ต้องใช้แพ็กเกจไวท์เลเบล หากร้านค้าของคุณใช้แพ็กเกจนี้อยู่แล้ว โปรดเขียนถึง [email protected].

สถานะใบแจ้งหนี้

ข้อผิดพลาด

มีคำถาม? เขียนถึงเราที่ [email protected]