Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.

Path Parameters

id
string
required

Invoice ID (prefix: inv_).

Response

A Fonepay Direct-QR was minted for the invoice. (Response carries an extra invoice_id.)

A Direct-QR session for Fonepay. Embed qr_image in your UI and subscribe to events_url for live status.

id
string

Session ID. Also the listener token for the SSE events stream.

Example:

"cs_01j9x2k3m4n5p6q7r8s9t0u1v2"

livemode
boolean

true when created with a live key, false for sandbox.

amount
integer

Amount in paisa.

Example:

10000

currency
string
Example:

"NPR"

provider
enum<string>
Available options:
fonepay
status
enum<string>

Always initiated on creation.

Available options:
initiated
qr_message
string

Raw Fonepay QR payload string. Encode this if rendering your own QR.

qr_image
string

Base64-encoded PNG data URL of the QR (320px).

Example:

"data:image/png;base64,iVBORw0KGgo..."

events_url
string<uri>

Server-Sent Events URL streaming qr.scanned / qr.paid / qr.expired events. No API key required - the session ID is the listener token.

Example:

"https://api.paybridgenp.com/v1/qr/cs_01j9x2k3m4n5p6q7r8s9t0u1v2/events"

expires_at
string<date-time>

When the Fonepay QR expires.