@easytransfert/sdk-api-marchand-nodejs
v1.0.0
Published
SDK Node.js pour l’intégration des paiements marchands
Downloads
39
Maintainers
Readme
EasyTransfert Node.js SDK
SDK officiel EasyTransfert pour faciliter l'intégration des API marchands (collecte, transfert, balance et statut de transaction) dans les applications Node.js.
- ✅ Simple à intégrer
- ✅ Typé (TypeScript) avec exports de tous les types publics
- ✅ Robuste et sécurisé
- ✅ Adapté aux environnements sandbox et production
Installation
npm install @easytransfert/sdk-api-marchand-nodejsConfiguration
import { EasyTransfertSDK } from "@easytransfert/sdk-api-marchand-nodejs";
const sdk = new EasyTransfertSDK({
apiKey: "votre-api-key",
ipn_url: "https://votre-domaine.com/webhook/ipn",
// baseUrl: "https://custom-url.com/api_v1" // optionnel
});| Paramètre | Type | Requis | Description |
| ---------- | -------- | ------ | -------------------------------------------------- |
| apiKey | string | ✅ | Votre clé API marchand EasyTransfert |
| ipn_url | string | ✅ | URL de notification instantanée (webhook) |
| baseUrl | string | ❌ | URL de base de l'API (défaut: production) |
Utilisation
Cashout (Collecte)
const response = await sdk.cashout.cashout({
amount: 500,
destination: "0700000000",
ipn_url: "https://votre-domaine.com/webhook/ipn",
api_key: "votre-api-key",
business_name_id: "votre-business-id",
service_id: 17,
custom_data: "commande-12345",
});
console.log(response.data.transaction_id);
console.log(response.data.state);Cashin (Transfert)
const response = await sdk.cashin.cashin({
amount: 1000,
destination: "0700000000",
ipn_url: "https://votre-domaine.com/webhook/ipn",
api_key: "votre-api-key",
business_name_id: "votre-business-id",
service_id: 17,
});Vérifier le statut d'une transaction
const status = await sdk.transactionStatus.checkStatus({
transaction_ids: "txn_abc123",
api_key: "votre-api-key",
});Consulter le solde
const balance = await sdk.balance.getBalance({
api_key: "votre-api-key",
});Types TypeScript
Tous les types sont exportés et disponibles à l'import :
import {
EasyTransfertSDK,
SDKConfig,
CashoutPayload,
TransactionPayloadResponse,
CashinPayload,
BalancePayload,
CheckStatusPayload,
} from "@easytransfert/sdk-api-marchand-nodejs";Développement
# Installer les dépendances
npm install
# Build
npm run build
# Tests unitaires
npm test
# Tests d'intégration (nécessite .env avec credentials)
cp .env.example .env
npm run test:liveLicence
MIT © EasyTransfert
