APIs used for Integration
Use these APIs to collect cross-border import payments, manage trade documents and subscriptions, and reconcile payments and settlements.
Collect payment
| Use case → Reference | command / primary value | Description |
|---|---|---|
| PayU Hosted Checkout | _payment | Initiate a cross-border payment on PayU Hosted Checkout with buyer_type_business and mandatory UDF fields. |
| Collect Payment API – Cards | _payment | Submit merchant-hosted card payment requests for cross-border one-time transactions. |
| Collect Payment API – NetBanking | _payment | Initiate NetBanking payments for cross-border transactions. Used in: NetBanking Integration. |
| Collect Payment API – UPI | _payment | Initiate UPI Intent payments for cross-border transactions. |
Update transaction data and upload invoices
| Use case → Reference | command / primary value | Description |
|---|---|---|
| UDF Update API | udf_update | Update UDF1–UDF5 values, including invoice ID, on a completed transaction. Used in: Integrate Cross-Border Payments with PayU and Import Plugin Integration. |
| Invoice Upload API | opgsp_upload_invoice_awb | Upload invoice documents and AWB files required for bank processing and settlement. |
Manage PACB subscriptions
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Payment Consent Transaction – PayU Hosted | _payment | Register a subscription mandate on PayU Hosted Checkout for cross-border recurring payments. |
| Registration Mandate for Cards | _payment | Register a card mandate for cross-border subscription consent transactions. |
| UPI Consent Transaction | _payment | Register a UPI mandate for cross-border subscription consent transactions. |
| Pre-Debit Notification API | pre_debit_SI | Notify the customer at least 48 hours before executing a recurring debit. |
| Recurring Payment Transaction API | si_transaction | Execute recurring debits against a registered cross-border mandate. |
Manage PACB settlements
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Get On-Hold Transactions API | GET /opgsp/getOnHoldTxnDetails | Retrieve transactions held pending additional invoice or trade metadata. |
| Update On-Hold Transactions API | POST /opgsp/updateOnHoldTxnDetails | Submit additional customer or trade information to release on-hold settlements. |
| Settlement Detail Range API | GET /settlement/range/ | Retrieve paginated transaction-level settlement data for a date range or UTR. |
| Get Settlement Detail API | get_settlement_details | Retrieve settlement details for cross-border transactions. |
Verify the payment
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Verify Payment API | verify_payment | Reconcile the transaction status from your server after payment. |
LRS
| API name | Purpose |
|---|---|
| PayU Hosted Checkout | Initiate LRS transactions on PayU Hosted Checkout with lrs_service_type and buyer PAN details. |
| Merchant Hosted Checkout | Submit merchant-hosted S2S payment requests with mandatory LRS parameters (lrs_service_type, TCS declarations, PAN in UDF fields). |
| Collect Payment API – UPI | Initiate UPI Intent payments for cross-border LRS transactions. |
| Collect Payment API – NetBanking | Initiate NetBanking payments for cross-border LRS transactions. |
| Get Token API – Partner Integration | Generate a bearer token with get_pan_details scope for PAN Card Status Check API authentication. |
| Verify Payment API | Server-side reconciliation of transaction status after payment. |
Updated 20 days ago
Did this page help you?
