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.

Body

application/json
customerPhone
string
required

Nepali mobile number of the customer (must match a recent pending session).

Example:

"9801234567"

shopName
string
required
Example:

"Acme Store"

orderName
string
required
Example:

"#1042"

amountMinor
integer
required

Amount in paisa (minor units).

Example:

10000

currency
string
required
Example:

"NPR"

checkoutUrl
string<uri>
required

Hosted checkout URL. Must be on an allowed PayBridgeNP checkout host for the project.

Example:

"https://checkout.paybridgenp.com/checkout/cs_01j9x2k3m4n5p6q7r8s9t0u1v2"

Response

Dispatch attempted. Check sent / status for the outcome.

sent
boolean

true only when the SMS was accepted for delivery (status is sent).

status
string

What happened to the message, as shown in your SMS log.

Example:

"sent"