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

Checkout session ID (prefix: cs_).

Response

Checkout session object.

A checkout session, as returned by the read-only /v1/sessions endpoints.

id
string
Example:

"cs_01j9x2k3m4n5p6q7r8s9t0u1v2"

livemode
boolean

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

mode
enum<string>
Available options:
sandbox,
live
flow
enum<string>

hosted renders the PayBridgeNP picker; redirect 302s straight to the provider.

Available options:
hosted,
redirect
amount
integer

Amount in paisa.

Example:

10000

currency
string
Example:

"NPR"

provider
enum<string> | null

Selected provider, or null if the customer will pick on the hosted page.

Available options:
esewa,
khalti,
fonepay
status
enum<string>

pending - created, not yet visited. initiated - customer redirected to provider. Then success / failed / cancelled / expired.

Available options:
pending,
initiated,
success,
failed,
cancelled,
expired
paymentId
string | null

The id of the successful payment for this session, or null until the session is paid. Use it with GET /v1/payments/{id} for full payment details (provider reference, refunds) - so a session_id from the return redirect is enough to reach the payment.

Example:

"pay_01j9x2k3m4n5p6q7r8s9t0u1v2"

description
string | null
metadata
object | null

Arbitrary key-value data you attached at checkout creation.

customerName
string | null
customerEmail
string | null
customerPhone
string | null
collectAddress
boolean
customerAddress
object | null

Collected billing address, or null if not collected.

expiresAt
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>