JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Getting Started

The Express Checkout API integration is a server-to-server integration. In this setup, the merchant manages the frontend (UI/UX) and handles the backend using Juspay APIs.

Integration Options

Juspay supports two modes of integration to suit different checkout experiences:

1. Separate Order Creation & Payment APIs `(/orders + /txns API)`

In this flow, you use two distinct API calls:

Step 1: Use the Create Order API to generate an order with amount, customer, and other relevant details.
Step 2: Once the user chooses a payment method, a transaction is initiated separately based on the selected mode (e.g., Card, Bank Transfers, Wallet Redirection, or RTP).

2. Create Order with Payments API `(/txns API)`

This API is typically invoked when the user clicks “Proceed to Pay” on your checkout screen. It combines all necessary order and payment data to initiate the transaction immediately.

refer to Step 3: Call Order with Payment API

Step-by-Step Integration

Step 1: Backend Integration

Use Juspay’s secure server-side APIs to:

Create and manage customers using the Get Customer, Create Customer and Update Customer APIs
Create order using Create Orders API
Handle Webhooks for real-time order status
Check Order Status using the Order Status API
Process Refunds using the Refund Order API

Depending on the integration, this can be either a Separate Order and Payments API or Create Order with Payments API.

Step 2: Testing & Go-Live

Share UAT Build: Once integration is done, submit your UAT build to Juspay for QA validation.
Removal of Restricted Mode: After QA approval, Juspay will switch your account to Live Mode.
Go Live: Your integration is now live and ready for real users to complete their checkout.

Monitor & Analyse Post Go-Live

After going live, deploy your app with production credentials and use the Juspay Dashboard & Analytics to:

Track live transactions in real time
Analyze success and failure rates across payment methods
View logs and webhook events for troubleshooting and monitoring

Refund Handling

Process refunds:

Via Juspay Dashboard: Issue refunds manually using Juspay’s Dashboard interface
Via Refund Order API: Automate refunds using the Refund Order API

Webhook Events: Get real-time notifications on refund status and completion through webhook events.

Additional Feature

Mandate Support

Support recurring/subscription-based payments with:

Mandate Registration: Used this API to set up standing instructions by selecting a preferred payment method
Mandate Execution: After registering a mandate, use the Mandate Execution API to trigger recurring transactions without user input.
Webhook Events: Receive notifications for mandate creation, execution, failure, expiry and other status updates via webhooks

Additional Developer Resources

Explore additional documentation and resources, including:

Core Resources

The Core Resources section provides essential technical references required to build and manage your payment integration effectively. This includes:

Gateway Reference ID: Helps map Juspay transaction IDs to gateway-specific references.
Transaction Status: API and status lifecycle documentation to track payments.
Webhooks: Details on all webhook types—Order, Transaction, Mandate, Refunds
Error Codes: A comprehensive list of standard and gateway-specific error codes for debugging.