Skip to main content
GET
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

Payment ID (prefix: pay_).

Response

Payment object.

id
string
Example:

"pay_01j9x2k3m4n5p6q7r8s9t0u1v2"

livemode
boolean

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

projectId
string
checkoutSessionId
string
Example:

"cs_01j9x2k3m4n5p6q7r8s9t0u1v2"

mode
enum<string>
Available options:
sandbox,
live
amount
integer

Amount in paisa.

Example:

10000

currency
string
Example:

"NPR"

provider
enum<string> | null
Available options:
esewa,
khalti,
fonepay
status
enum<string>
Available options:
pending,
processing,
success,
failed,
refunded,
cancelled
providerRef
string | null

Provider's transaction reference.

failureReason
string | null

Human-readable decline reason. null on success.

metadata
object | null

Arbitrary key-value data you attached at checkout creation.

customerName
string | null
customerEmail
string | null
customerPhone
string | null
createdAt
string<date-time>
updatedAt
string<date-time>