API Reference

Developer Documentation

Full reference for the Paynex REST API. Base URL: https://api.paynex.sg/v1

24Endpoints

18Webhook Events

5SDK Languages

v1.4.2API Version

Endpoints

POST/v1/charges

Create a new charge

Charges

Authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer pk_live_sg_••••••••••••

Request Body

Parameter	Type	Required	Description
amount	integer	required	Amount in cents (e.g. 5000 = SGD 50.00)
currency	string	required	ISO 4217 currency code. Must be "SGD"
method	string	required	Payment method: paynow, nets, grabpay, card
description	string	optional	Charge description shown on receipt
metadata	object	optional	Key-value pairs for your internal reference

Response

200 OK

{
  "id": "chg_sg_a1b2c3d4e5f6",
  "object": "charge",
  "amount": 5000,
  "currency": "SGD",
  "status": "succeeded",
  "method": "paynow",
  "description": "Order #1042",
  "customer": "cus_abc123",
  "metadata": {
    "order_id": "ord_1042"
  },
  "receipt_url": "https://pay.paynex.sg/r/chg_sg_...",
  "refunded": false,
  "refunds": [],
  "created_at": "2024-01-15T10:00:00+08:00",
  "paid_at": "2024-01-15T10:00:08+08:00",
  "livemode": true
}

Related Webhook Events

charge.succeeded—Fired when a payment is confirmed

charge.failed—Fired when a payment fails

charge.refunded—Fired when a refund is processed

charge.dispute.created—Fired when a dispute is opened