SaligPay (Main Client)
| Method | Returns | Description |
|---|---|---|
authenticate() | Promise<SaligPayAuthTokens> | Authenticate and store tokens |
isAuthenticated() | boolean | Check if currently authenticated |
getAccessToken() | string or undefined | Get current access token |
ensureAuthenticated() | Promise<void> | Ensure authentication, refresh if needed |
AuthResource
| Method | Returns | Description |
|---|---|---|
authenticate(clientId?, clientSecret?) | Promise<SaligPayAuthTokens> | Get access tokens |
refreshToken(refreshToken, clientId?) | Promise<SaligPayAuthTokens> | Refresh access token |
loginAndRetrieveCredentials(email, password, adminKey?) | Promise<LoginResult> | Full login flow |
internalAuthentication(userId, adminKey?) | Promise<LoginResult> | Internal auth by user ID |
validateToken(accessToken) | Promise<boolean> | Validate token validity |
CheckoutResource
| Method | Returns | Description |
|---|---|---|
create(options, accessToken?) | Promise<CreateCheckoutApiResponse> | Create checkout session |
setAccessToken(token) | void | Set default access token |
PaymentIntentResource
| Method | Returns | Description |
|---|---|---|
create(options, accessToken?) | Promise<PaymentIntentApiResponse> | Create payment intent |
confirm(intentId, options, accessToken?) | Promise<PaymentConfirmationApiResponse> | Confirm payment intent |
getStatus(intentId, accessToken?) | Promise<PaymentIntentApiResponse> | Get payment intent status |
setAccessToken(token) | void | Set default access token |
SubscriptionResource
| Method | Returns | Description |
|---|---|---|
initiate(options, accessToken?) | Promise<InitiateSubscriptionResponseDto> | Initiate subscription |
getSession(sessionToken, accessToken?) | Promise<GetSessionResponseDto> | Get subscription session |
processPayment(options, accessToken?) | Promise<ProcessSubscriptionPaymentResponseDto> | Process payment |
get(subscriptionId, accessToken?) | Promise<SubscriptionResponseDto> | Get subscription |
list(query?, accessToken?) | Promise<SubscriptionsListResponseDto> | List subscriptions |
updatePlan(subscriptionId, dto, accessToken?) | Promise<SubscriptionResponseDto> | Update plan |
updatePaymentMethod(subscriptionId, dto, accessToken?) | Promise<SubscriptionResponseDto> | Update payment method |
cancel(subscriptionId, reason?, accessToken?) | Promise<SubscriptionResponseDto> | Cancel subscription |
createPlan(data, accessToken?) | Promise<PlanDto> | Create a plan |
listPlans(query?, accessToken?) | Promise<PlansListResponseDto> | List plans |
getPlan(planId, accessToken?) | Promise<PlanDto> | Get plan by ID |
setAccessToken(token) | void | Set default access token |
PayoutResource
| Method | Returns | Description |
|---|---|---|
list(options?, accessToken?) | Promise<PayoutListResult> | List payouts |
get(id, accessToken?) | Promise<PayoutDetailResult> | Get payout detail |
getTransactions(id, options?, accessToken?) | Promise<PayoutTransactionsResult> | Get payout transactions |
getSchedule(merchantId, accessToken?) | Promise<PayoutScheduleResult> | Get payout schedule |
setAccessToken(token) | void | Set default access token |
WalletResource
| Method | Returns | Description |
|---|---|---|
get(id, accessToken?) | Promise<WalletAccountResult> | Get wallet account |
getBalance(id, accessToken?) | Promise<WalletBalanceResult> | Get wallet balance |
transfer(walletId, data, accessToken?) | Promise<CreateWalletTransferResponse> | Create transfer |
listTransfers(walletId, options?, accessToken?) | Promise<WalletTransferListResult> | List transfers |
getTransfer(walletId, transferId, accessToken?) | Promise<WalletTransferResult> | Get transfer |
setAccessToken(token) | void | Set default access token |
TransferResource
| Method | Returns | Description |
|---|---|---|
create(data, accessToken?) | Promise<BatchTransfer> | Create batch transfer |
list(options?, accessToken?) | Promise<TransferListResult> | List transfers |
get(id, accessToken?) | Promise<Transfer> | Get transfer |
setAccessToken(token) | void | Set default access token |
BankResource
| Method | Returns | Description |
|---|---|---|
getReceivingInstitutions(provider, accessToken?) | Promise<BankListResult> | List banks |
setAccessToken(token) | void | Set default access token |
WebhookResource
| Method | Returns | Description |
|---|---|---|
constructEvent(payload) | SaligPayWebhookPayload | Parse webhook body |
constructVerifiedEvent(payload, signature, timestamp?) | SaligPayWebhookPayload | Parse and verify webhook |
verifySignature(payload, signature, timestamp?) | boolean | Verify HMAC signature |
listen(req, res, handler) | Promise<void> | Express middleware handler |
process(payload, handler) | Promise<void> | Manual processing |
Last modified on