Get a checkout session
Retrieves a single checkout session by ID. Once the session is paid, the response includes paymentId - pass it to GET /v1/payments/{id} for full payment details. Requires the sessions:read scope.
Authorizations
Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.
Path Parameters
Checkout session ID (prefix: cs_).
Response
Checkout session object.
A checkout session, as returned by the read-only /v1/sessions endpoints.
"cs_01j9x2k3m4n5p6q7r8s9t0u1v2"
true when created with a live key, false for sandbox.
sandbox, live hosted renders the PayBridgeNP picker; redirect 302s straight to the provider.
hosted, redirect Amount in paisa.
10000
"NPR"
Selected provider, or null if the customer will pick on the hosted page.
esewa, khalti, fonepay pending - created, not yet visited. initiated - customer redirected to provider. Then success / failed / cancelled / expired.
pending, initiated, success, failed, cancelled, expired 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.
"pay_01j9x2k3m4n5p6q7r8s9t0u1v2"
Arbitrary key-value data you attached at checkout creation.
Collected billing address, or null if not collected.