SaligPay is a payment platform for merchants. The API lets you authenticate, create checkout sessions, manage subscriptions and refunds, handle payouts and transfers, manage wallets, and receive real-time payment events via webhooks.
What the API offers
- Authentication — OAuth 2.0 client credentials to obtain access tokens for API calls
- Checkout — Create payment sessions with amount, customer contact, and return URLs; redirect customers to a hosted checkout to complete payment
- Payment Intent — Lower-level control over payment flows when you need custom UIs or logic
- Subscriptions — Recurring billing and subscription lifecycle management
- Refunds — Refund payments and track refund status
- Transactions — List and inspect payment history
- Payouts — Manage merchant payouts to bank accounts and track payout status
- Wallets — Digital wallet management for storing and managing funds
- Transfers — Transfer funds between wallets and accounts
- Banks — Retrieve receiving institutions and bank information for payouts
- Webhooks — Receive events when payment status changes (e.g. completed, failed, pending)
Core concepts
Authentication
API access is secured with OAuth 2.0 client credentials. You exchange a client ID and secret for access and refresh tokens. Use the access token on requests; refresh it when it expires. The OAuth API and API Reference describe the endpoints.
Checkout sessions
A checkout session represents a single payment flow. You create a session with an external reference ID, amount (in centavos), customer contact info, a webhook URL for status updates, and a return URL for after payment. The API returns a checkoutUrl; redirect the customer there to complete payment. See Checkout in the API Reference.
Payment Intents
Payment intents provide lower-level control over payment flows when you need custom UIs or logic. Create an intent, confirm it, and track its status through the payment lifecycle. See Payment Intent in the API Reference.
Subscriptions
Subscriptions enable recurring billing for your customers. Create subscription plans, subscribe customers, and manage the subscription lifecycle including upgrades, downgrades, and cancellations. See Subscription and Plans in the API Reference.
Payouts
Payouts allow you to transfer funds from your merchant account to bank accounts. Schedule payouts, track their status, and view payout history. See Payouts in the API Reference.
Wallets
Wallets provide digital storage for funds within the SaligPay platform. Check balances, manage wallet transactions, and transfer funds between wallets. See Wallet in the API Reference.
Transfers
Transfers enable moving funds between wallets and accounts. Create transfers, track their status, and manage disbursements. See Transfers in the API Reference.
Banks
The Banks API provides information about receiving institutions and bank details needed for payouts. Retrieve bank lists and validate bank information. See Banks in the API Reference.
Webhooks
SaligPay sends HTTP POST requests to your webhook URL when payment state changes (e.g. COMPLETED, FAILED, PENDING). Implement a public endpoint that accepts these payloads and updates your system (e.g. mark orders as paid). See Checkout Webhook for payload shapes and events.
Next steps
- API Reference — Full endpoint reference for Checkout, Payment Intent, Subscriptions, Plans, Refunds, Transactions, Payouts, Wallets, Transfers, Banks, OAuth, and Webhooks
- SaligPay Node SDK — Official Node.js SDK for type-safe integration (installation, quick start, and framework guides)
- SDK Reference — Complete SDK API reference with all available methods and types