Docs / Getting Started

FOXPAY API REST API

Dokumentasi integrasi resmi layanan FOXPAY API. Gunakan REST API untuk melakukan pengecekan stok katalog real-time dan mengeksekusi pembelian otomatis menggunakan saldo akun pengguna.

Autentikasi API Key

Simpan API Key di peramban ini agar seluruh request di dokumentasi ini siap dijalankan.

Header

Setiap request yang membutuhkan izin akun wajib menyertakan header X-API-Key: foxpay-xxx atau Authorization: Bearer foxpay-xxx.

Contoh Request Pembelian

POST /api/orders 201 Created

curl -X POST "http://localhost:3000/api/orders" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: foxpay-8cb6f7f22410..." \
  -d '{"productId": 7, "variantId": 7, "qty": 1}'

// Respon Berhasil (Saldo Langsung Terpotong & Kredensial Produk Diterima):
{
  "ok": true,
  "message": "Pembelian berhasil menggunakan saldo akun.",
  "order": {
    "id": "TRXMTR89A",
    "status": "paid",
    "product_name": "CODEBUDDY",
    "variant_name": "Api 350 credits",
    "price": 3000,
    "qty": 1,
    "total": 3000,
    "items": [
      "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIs..."
    ],
    "balance_remaining": 147000,
    "paid_at": "2026-09-08T12:00:00.000Z"
  }
}

Daftar Status HTTP & Kode Error

Status	Error Code	Keterangan
200 OK	-	Request berhasil dieksekusi.
201 Created	-	Order berhasil diproses via saldo dan item produk langsung diserahkan.
400 Bad Request	INSUFFICIENT_BALANCE	Saldo user tidak mencukupi untuk melakukan pembelian.
400 Bad Request	OUT_OF_STOCK	Stok varian produk kosong atau kurang dari jumlah diminta.
401 Unauthorized	UNAUTHORIZED	Header X-API-Key atau Authorization Bearer belum disertakan.
401 Unauthorized	INVALID_API_KEY	API Key salah atau tidak ditemukan di database.
404 Not Found	NOT_FOUND	Produk, varian, atau ID transaksi tidak ditemukan.
429 Too Many Requests	TOO_MANY_REQUESTS	Batas request terlampaui (default: 60 req/menit).