APIs used in Integration
Use these APIs to manage closed-loop wallet customers, load funds, debit wallets, and retrieve transaction status and history.
Manage customers
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Register Customer API | POST /v1/wallet/enroll | Onboard a customer and create a closed-loop wallet account. |
| Retrieve Customer Record API | POST /v1/wallet/retrieveCustRecord | Fetch customer details and wallet balance before debit or load operations. |
| Update Profile API – Closed Loop | PATCH /v1/wallet/onboarding/v3/updateProfile | Update customer profile details for a closed-loop wallet. |
| Change Wallet Status API | PATCH /v1/wallet/onboarding/walletStatus | Change the wallet status for a customer account. |
Load funds
| Use case → Reference | command / primary value | Description |
|---|---|---|
| PG Load API | POST /ppi/payment/pg-load/v1 | Initiate a wallet top-up through the payment gateway. |
| PG Load Enquiry API | POST /ppi/payment/pg-load/enquiry/v1 | Check the status of a PG Load transaction during the top-up journey. |
| Load API – Closed Loop Wallet | PATCH /v1/wallet/load-account | Credit the wallet after a successful payment gateway transaction. |
| Check Status API – CLW | POST /v1/wallet/check-status | Check the status of a load transaction in the top-up journey. |
Debit the wallet
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Seamless Debit Transaction API | _payment | Debit the wallet through a server-to-server request without user redirection. |
| Non-Seamless Debit Transaction API | _payment | Debit the wallet through PayU Hosted Checkout with user authorization. |
| Seamless Debit Enquiry API | _payment | Check the status of a seamless debit transaction. |
| Load and Pay Transaction API | _payment | Load funds and debit the wallet in one request when the balance is insufficient. |
| Collect Payment API – PayU Hosted Checkout | _payment | Redirect customers to PayU Hosted Checkout for wallet debit or load-and-pay flows. |
Enquiries
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Statement Inquiry API – CLW | POST /v1/wallet/statement-inquiry | Fetch wallet transaction history for a date range. |
| Verify Payment API | verify_payment | Reconcile wallet load or payment gateway transaction status from your server. |
Note: To unload your wallet, refer to Seamless Debit Integration - CLW or PayU Hosted Check-out Integration - CLW based on the integration.
Updated 11 days ago
Did this page help you?