Pine Labs Payments API Reference
REST APIs for orders, payments, refunds, subscriptions, split settlements, payouts and checkout links — with live request examples in every major language.
Authentication
Authenticate API requests and generate Bearer access tokens using OAuth 2.0 client credentials flow.
Orders
Create payment orders, capture authorized payments, cancel pre-authorized orders, and retrieve order details by ID or merchant reference.
/api/pay/v1/orders/{order_id}/api/pay/v1/orders/reference/{merchant_order_reference}/api/pay/v1/orders/{order_id}/capture/api/pay/v1/orders/{order_id}/cancel/api/pay/v1/ordersRefunds
Create full or partial refunds against completed payment orders with idempotent request handling.
Settlements
Retrieve settlement reports and details, search by UTR number for bank reconciliation and payout tracking.
Split Settlements
Release held funds to sub-merchants or vendors in marketplace flows, or cancel pending split settlements.
Checkout
Generate hosted checkout page URLs to accept payments without custom frontend integration.
Payment Links
Create shareable payment links, retrieve link details, cancel active links, and resend notifications via SMS or email.
/api/pay/v1/paymentlink/api/pay/v1/paymentlink/{payment_link_id}/api/pay/v1/paymentlink/ref/{merchant_payment_link_reference}/api/pay/v1/paymentlink/{payment_link_id}/cancel/api/pay/v1/paymentlink/{payment_link_id}/notifyCard Payments
Process credit and debit card payments with OTP authentication, 3D Secure, BIN lookup, and decoupled authorization.
/api/pay/v1/orders/{order_id}/payments/api/pay/v1/otp/generate/api/pay/v1/getCardDetails/api/pay/v1/otp/submit/api/pay/v1/otp/resend/api/pay/v1/orders/{order_id}/payments/{payment_id}/authorizeUPI Payments
Process UPI payments via collect requests, intent flows, and QR codes with VPA validation.
NetBanking
Process net banking payments from all major Indian banks with secure redirect flows.
Wallet
Process digital wallet payments including Paytm, PhonePe, Amazon Pay with OTP authentication.
Pay by Points
Verify VPA and check reward points balance to process payments using customer loyalty points.
E-Challans
Create electronic challans for government and institutional fee collection, retrieve challan details and download PDF receipts.
Apple Pay
Authorize Apple Pay payments by processing encrypted payment tokens from Apple Wallet on iOS.
International Payments
Process cross-border card payments in 100+ currencies, compute TCS for LRS remittance, manage invoices and AWB documents for compliance.
/api/conversion/mcc/api/v1/tcs/compute/api/pay/v1/orders/{orderId}/invoice/api/pay/v1/orders/{orderId}/invoice/api/pay/v1/orders/{orderId}/invoice/{invoiceId}/upload/api/pay/v1/orders/{orderId}/awb/api/pay/v1/orders/{orderId}/awb/api/pay/v1/orders/{orderId}/awb/{awbId}/api/pay/v1/orders/{orderId}/awb/{awbId}/uploadCustomers
Create customer profiles, update customer information, and retrieve customer details for tokenization and subscriptions.
Tokenization
Generate RBI-compliant card tokens, retrieve service provider tokens, create cryptograms, and manage saved cards for one-click payments.
/api/v1/tokens/api/v1/tokens/{identifier}/api/v1/tokens/{token_id}/token-transactional-data/api/v1/tokens/{token_id}/delete/api/v1/customer/{customer_id}/tokens/api/v1/customer/{customer_id}/tokens/{token_id}/api/v1/customer/{customer_id}/tokens/{token_id}/deletePayouts
Transfer funds to bank accounts via IMPS, NEFT, or RTGS with support for instant, scheduled, and bulk payouts.
/payouts/v3/payments/banks/payouts/v3/payments/payouts/v3/payments/funding-account/payouts/v3/payments/banks/file/payouts/v3/payments/banks/{paymentReferenceId}/payouts/v3/payments/banks/{paymentReferenceId}/cancelAffordability Suite
Discover EMI offers and bank discounts, validate offer eligibility, check IMEI for device financing, and process affordability payments.
/api/affordability/v1/offer/discovery/api/affordability/v2/offer/discovery/api/affordability/v1/offer/discovery/cardless/api/affordability/v1/offer/downpayment/details/api/affordability/v1/offer/validate/api/affordability/v1/product/{order_id}/imei/api/pay/v1/orders/{order_id}/paymentsBNPL
Check customer eligibility for Buy Now Pay Later, submit OTP for authentication, and process pay later transactions.
Convenience Fee
Calculate applicable convenience fees and surcharges for different payment methods and transaction amounts.
Payment Option
Verify UPI VPA details and check payment eligibility before initiating transactions.
Brand Wallet
Create brand wallets, validate wallet eligibility, activate/deactivate wallets, check balance, load funds, reset PIN, and view transaction history.
/payment-option/create/wallet/payment-option/wallet/validate/payment-option/wallet/balance/payment-option/wallet/customer/{customer_id}/activate/payment-option/wallet/customer/{customer_id}/deactivate/payment-option/wallet/customer/{customer_id}/reset/payment-option/wallet/load/payment-option/wallet/customer/{customer_id}/historyBrand Wallet Payments
Process payments using brand wallet balance and add money via gift cards or UPI for closed-loop payment programs.
Subscriptions - Plans
Create subscription plans with billing frequency and amount, retrieve plan details, update or delete plans.
/ps/api/v1/public/plans/ps/api/v1/public/plans/ps/api/v1/public/plans/{plan_id}/ps/api/v1/public/plans/{plan_id}/ps/api/v1/public/plans/{plan_id}/ps/api/v1/public/plans/reference/{merchant_plan_reference}Subscriptions - Subscriptions
Create recurring payment subscriptions with auto-debit mandates, manage subscription lifecycle including pause, resume, and cancellation.
/ps/api/v1/public/subscriptions/ps/api/v1/public/subscriptions/ps/api/v1/public/subscriptions/{subscription_id}/ps/api/v1/public/subscriptions/{subscription_id}/ps/api/v1/public/subscriptions/reference/{merchant_subscription_reference}/ps/api/v1/public/subscriptions/{subscription_id}/cancel/ps/api/v1/public/subscriptions/{subscription_id}/pause/ps/api/v1/public/subscriptions/{subscription_id}/resumeSubscriptions - Presentations
Submit debit requests against active subscription mandates, send pre-debit notifications, and retry failed collections.
/ps/api/v1/public/subscriptions/{subscription_id}/presentations/ps/api/v1/public/subscriptions/{subscription_id}/presentations/ps/api/v1/public/presentations/{presentation_id}/ps/api/v1/public/presentations/{presentation_id}/ps/api/v1/public/presentations/reference/{merchant_presentation_reference}/ps/api/v1/public/subscriptions/notify/ps/api/v1/public/subscriptions/execute/ps/api/v1/mandate/merchant-retryUPI Reserve Pay
Create SBMD-enabled subscriptions to reserve funds in UPI accounts and process debits against blocked amounts.
