payssion-nodejs
v1.0.1
Published
Payssion Nodejs library
Downloads
12
Maintainers
Readme
payssion-nodejs
Payssion library for Nodejs.
Installation
npm install payssion-nodejsUsage
Initialize the client
const PayssionClient = require("payssion-nodejs");
// For live mode
const client = new PayssionClient("your_api_key", "your_secret_key", true);
// For sandbox mode
const client = new PayssionClient("your_api_key", "your_secret_key", false);Create a payment
const params = {
pm_id: "alipay_cn",
amount: 10.0,
currency: "USD",
order_id: "your_order_id",
description: "Payment for order",
return_url: "https://your-site.com/return",
notify_url: "https://your-site.com/notify",
};
try {
const result = await client.create(params);
console.log("Payment created:", result);
if (client.getIsSuccess()) {
console.log("Payment URL:", result.redirect_url);
}
} catch (error) {
console.error("Error creating payment:", error.message);
}Get payment details
const params = {
transaction_id: "payssion_transaction_id",
order_id: "your_order_id",
};
try {
const result = await client.getDetails(params);
console.log("Payment details:", result);
} catch (error) {
console.error("Error getting payment details:", error.message);
}Refund a payment
const params = {
transaction_id: "payssion_transaction_id",
amount: 10.0,
currency: "USD",
};
try {
const result = await client.refund(params);
console.log("Refund result:", result);
} catch (error) {
console.error("Error processing refund:", error.message);
}Configuration
Set custom API URL
client.setUrl("https://custom-api-url.com/api/v1/");Disable SSL verification (not recommended for production)
client.setSSLverify(false);API Methods
create(params)
Create a new payment order.
Parameters:
pm_id(string): Payment method IDamount(number): Payment amountcurrency(string): Currency code (e.g., 'USD', 'EUR')order_id(string): Your unique order IDdescription(string): Payment descriptionreturn_url(string): URL to redirect after paymentnotify_url(string): URL for payment notifications
getDetails(params)
Get payment details.
Parameters:
transaction_id(string): Payssion transaction IDorder_id(string): Your order ID
refund(params)
Refund a payment.
Parameters:
transaction_id(string): Payssion transaction IDamount(number): Refund amountcurrency(string): Currency code
Error Handling
The library throws errors for various scenarios:
- Invalid API credentials
- Network errors
- HTTP errors (400, 401, 500, etc.)
- Invalid parameters
Always wrap API calls in try-catch blocks to handle errors properly.
Requirements
- Node.js >= 12.0.0
- axios for HTTP requests
License
MIT
Support
For support, please contact Payssion support team or visit the official documentation.
