An unofficial Node.js TypeScript SDK for the Sipay payment gateway.
- π Automatic authentication handling
- π³ Support for 2D and 3D Secure payments
- π Recurring payments
- π·οΈ Branded payment solutions
- π Commission information
- π·οΈ Status code management with detailed error handling
- π‘οΈ Type-safe with TypeScript
- β Input validation
- π Secure payment processing
- π Comprehensive documentation
pnpm add @muhammedaksam/sipay-nodeOr with npm:
npm install @muhammedaksam/sipay-nodeOr with yarn:
yarn add @muhammedaksam/sipay-nodeimport Sipay from '@muhammedaksam/sipay-node';
const sipay = new Sipay({
appId: 'your-app-id',
appSecret: 'your-app-secret',
merchantKey: 'your-merchant-key',
// baseUrl: 'https://provisioning.sipay.com.tr/ccpayment', // Optional, defaults to production
});
// Example: Process a 2D payment
try {
const result = await sipay.payments.pay2D({
cc_holder_name: 'John Doe',
cc_no: '4111111111111111',
expiry_month: '12',
expiry_year: '2025',
cvv: '123',
currency_code: 'TRY',
installments_number: 1,
invoice_id: 'INV123456',
invoice_description: 'Test payment',
total: 100.0,
items: [
{
name: 'Product 1',
price: 100.0,
qnantity: 1,
description: 'Test product',
},
],
name: 'John',
surname: 'Doe',
});
if (result.status_code === 100) {
console.log('Payment successful!');
} else {
console.log('Payment failed:', result.status_description);
}
} catch (error) {
console.error('Payment error:', error.message);
}interface SipayConfig {
appId: string; // Your Sipay App ID
appSecret: string; // Your Sipay App Secret
merchantKey: string; // Your Merchant Key
baseUrl?: string; // API base URL (optional)
timeout?: number; // Request timeout in ms (optional, default: 80000)
}const result = await sipay.payments.pay2D({
cc_holder_name: 'John Doe',
cc_no: '4111111111111111',
expiry_month: '12',
expiry_year: '2025',
cvv: '123',
currency_code: 'TRY',
installments_number: 1,
invoice_id: 'unique-invoice-id',
invoice_description: 'Payment description',
total: 100.0,
items: [
{
name: 'Product Name',
price: 100.0,
qnantity: 1,
description: 'Product description',
},
],
name: 'Customer Name',
surname: 'Customer Surname',
hash_key: 'optional-hash-key',
});const result = await sipay.payments.pay3D({
// Same parameters as pay2D
cc_holder_name: 'John Doe',
cc_no: '4111111111111111',
// ... other fields
});
// The result contains HTML form for 3D Secure authentication
// You need to render this form in the browserconst posInfo = await sipay.payments.getPos({
credit_card: '411111', // First 6 digits
amount: '100.00',
currency_code: 'TRY',
is_2d: 0, // 0 for 3D, 1 for 2D
});const status = await sipay.payments.checkStatus({
invoice_id: 'your-invoice-id',
include_pending_status: 'true',
});const refund = await sipay.payments.refund({
invoice_id: 'your-invoice-id',
amount: '50.00', // Partial or full refund
});const plans = await sipay.recurring.query({
plan_code: 'your-plan-code',
app_id: 'your-app-id',
app_secret: 'your-app-secret',
});const result = await sipay.recurring.processPlan({
merchant_id: 'your-merchant-id',
plan_code: 'your-plan-code',
});const link = await sipay.brandedSolution.createPaymentLink({
invoice_id: 'unique-invoice-id',
invoice_description: 'Payment description',
total: 100.0,
currency_code: 'TRY',
items: [
{
name: 'Product Name',
price: 100.0,
qnantity: 1,
description: 'Product description',
},
],
name: 'Customer Name',
surname: 'Customer Surname',
return_url: 'https://yoursite.com/success',
cancel_url: 'https://yoursite.com/cancel',
});
// Redirect customer to link.data.linkconst status = await sipay.brandedSolution.checkStatus({
invoice_id: 'your-invoice-id',
is_direct_bank: 1,
});const commissions = await sipay.commissions.getCommissions({
currency_code: 'TRY',
});The SDK includes utility functions for common tasks:
import {
generateHashKey,
validateCreditCard,
formatAmount,
generateInvoiceId,
validatePaymentData,
maskCreditCard,
} from '@muhammedaksam/sipay-node';
// Generate hash key for payment verification
const hashKey = generateHashKey(merchantKey, invoiceId, amount, secretKey);
// Validate credit card number
const isValid = validateCreditCard('4111111111111111');
// Generate unique invoice ID
const invoiceId = generateInvoiceId('ORDER');
// Validate payment data
const errors = validatePaymentData(paymentData);
// Mask credit card for logging
const masked = maskCreditCard('4111111111111111'); // "4111****1111"The SDK throws SipayError objects with detailed information:
try {
const result = await sipay.payments.pay2D(paymentData);
} catch (error) {
if (error.type === 'SipayError') {
console.log('Status Code:', error.status_code);
console.log('Description:', error.status_description);
} else {
console.log('Network Error:', error.message);
}
}All API methods return a standardized response:
interface SipayApiResponse<T = any> {
status_code: number; // 100 for success
status_description: string;
data?: T; // Response data (if any)
message?: string; // Additional message
status?: boolean; // Alternative status flag
link?: string; // Payment link (for branded solutions)
}The SDK provides comprehensive status code utilities to help you handle different payment scenarios effectively.
import { SipayStatusCode, getStatusCodeInfo, getSuggestedAction } from '@muhammedaksam/sipay-node';
// Status code enums
SipayStatusCode.SUCCESSFUL; // 100 - Payment successful
SipayStatusCode.BASIC_VALIDATION; // 1 - Basic validation error
SipayStatusCode.INVALID_CREDENTIALS; // 30 - Authentication failed
SipayStatusCode.ORDER_FAILED; // 41 - Payment failed
SipayStatusCode.CREDIT_CARD_BLOCKED; // 44 - Card blocked
SipayStatusCode.REFUND_FAILED; // 49 - Refund error
SipayStatusCode.FOREIGN_CARDS_NOT_ALLOWED; // 76 - Foreign cards not allowed
// ... and 50+ more status codesimport {
getStatusCodeInfo,
getSuggestedAction,
StatusCodeGroups,
isStatusInGroup,
} from '@muhammedaksam/sipay-node';
// Get detailed information about a status code
const info = getStatusCodeInfo(response.status_code);
console.log(info.description); // Human-readable description
console.log(info.category); // 'success', 'validation_error', 'payment_error', etc.
console.log(info.isRetryable); // Whether the error can be retried
console.log(info.httpEquivalent); // HTTP status equivalent (if applicable)
// Get actionable suggestions
const suggestion = getSuggestedAction(response.status_code);
console.log(suggestion); // "Check payment details and try with different parameters"
// Use predefined groups for easy error handling
if (isStatusInGroup(response.status_code, StatusCodeGroups.VALIDATION_ERRORS)) {
console.log('Please fix the validation errors in your request');
} else if (isStatusInGroup(response.status_code, StatusCodeGroups.CARD_ERRORS)) {
console.log('Please try with a different card');
}import { SipayStatusCode, getStatusCodeInfo } from '@muhammedaksam/sipay-node';
try {
const response = await sipay.payments.pay2D(paymentData);
if (response.status_code === SipayStatusCode.SUCCESSFUL) {
console.log('β
Payment successful!');
console.log('Order ID:', response.data?.order_id);
} else {
// Handle non-success responses with detailed status information
const statusInfo = getStatusCodeInfo(response.status_code);
console.log('β Payment failed:');
console.log('Status Code:', statusInfo.code);
console.log('Description:', statusInfo.description);
console.log('Category:', statusInfo.category);
// Handle retryable errors
if (statusInfo.isRetryable) {
console.log('π This error is retryable - you can try again after a delay');
// Implement retry logic here
}
}
} catch (error) {
// SDK errors now include enhanced status information
if (error.status_code) {
const statusInfo = getStatusCodeInfo(error.status_code);
console.log('Error category:', statusInfo.category);
console.log('Suggested action:', getSuggestedAction(error.status_code));
}
}The SDK categorizes status codes for easier error handling:
- Success:
100,101,112- Transaction completed successfully - Validation Errors:
1,12,13,32,33,85,108,404- Request validation issues - Authentication Errors:
30,34,79,87- Credential or permission issues - Payment Errors:
41,43,49,31,69,105- Payment processing failures - Merchant Errors:
14,37,38,44,45-48,80,106- Merchant configuration issues - Card Errors:
44,60,70,76,77,86,88-89- Card-related problems - Hash Errors:
68,90-97- Hash key validation failures - Recurring Errors:
55,71,73- Recurring payment issues - Retryable Errors:
3,49,69,117- Temporary errors that can be retried
# Clone the repository
git clone https://github.com/muhammedaksam/sipay-node.git
# Install dependencies
pnpm install
# Run tests
pnpm test
# Build the project
pnpm run build
# Run linting
pnpm run lint
# Format code
pnpm run format- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
This is an unofficial SDK for Sipay. Please refer to the official Sipay API documentation for the most up-to-date API information.
This SDK is built based on the official Sipay API documentation available at https://apidocs.sipay.com.tr/indexEn.html.
If you encounter any issues or have questions, please open an issue on GitHub.
See CHANGELOG.md for a list of changes.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}