Démarrage rapide

Initialisation

L’initialisation se fait via la méthode statique init(). Le SDK gère ensuite automatiquement l’authentification et le cycle de vie des tokens.

import com.gimpaysdk.facade.GIMpaySdk;

// Initialisez le SDK une seule fois dans votre application (voir Bonnes Pratiques)
GIMpaySdk sdk = GIMpaySdk.init(
    "VOTRE_CLIENT_ID",
    "VOTRE_CLIENT_SECRET",
    "https://api.gimpay.com"  // URL de l'API GIMpay
);

Ne codez jamais vos identifiants en dur. Utilisez des variables d’environnement ou un gestionnaire de secrets :

String clientId = System.getenv("GIMPAY_CLIENT_ID");
String clientSecret = System.getenv("GIMPAY_CLIENT_SECRET");
String baseUrl = System.getenv("GIMPAY_BASE_URL");
GIMpaySdk sdk = GIMpaySdk.init(clientId, clientSecret, baseUrl);

Services disponibles

Le SDK est organisé en services, chacun accessible via une méthode dédiée sur l’instance sdk.

Service	Méthode d’accès	Description
`WalletService`	`sdk.wallets()`	Gestion des portefeuilles et instruments de paiement.
`OperationService`	`sdk.operations()`	Exécution et annulation d’opérations financières.
`UserService`	`sdk.users()`	Enrôlement et gestion des utilisateurs, bénéficiaires…
`CatalogService`	`sdk.catalog()`	Consultation des produits, contributeurs, pays…
`FeeService`	`sdk.fees()`	Calcul des frais de transaction.
`OtpService`	`sdk.otp()`	Génération et validation d’OTP.
`ConsentService`	`sdk.consents()`	Gestion des consentements.
`DocumentService`	`sdk.documents()`	Gestion des documents KYC.
`MmpService`	`sdk.mmp()`	Interaction avec les Mini-Marketplaces.
`LoyalityService`	`sdk.loyality()`	Programmes de fidélité.
`TerminalService`	`sdk.terminals()`	Gestion des terminaux de paiement.
`CountriesService`	`sdk.countries()`	Informations sur les pays.
`ContributorsService`	`sdk.contributors()`	Informations sur les contributeurs (banques, opérateurs…).
`CheckExistenceService`	`sdk.existence()`	Vérification d’existence d’entités.
`ContributorPortalService`	`sdk.contributorPortals()`	Fonctionnalités du portail contributeur.

Exemples d’utilisation

Consulter un solde

try {
    Double balance = sdk.wallets().getBalance("REF_WALLET_12345");
    System.out.println("Solde disponible : " + balance);
} catch (ApiException e) {
    System.err.println("Impossible de récupérer le solde : " + e.getMessage());
}

Enrôler un compte Mobile Money

import com.gimpaysdk.model.request.EnrollMobileWalletRequest;
import com.gimpaysdk.model.response.EnrollMobileWalletResponse;

EnrollMobileWalletRequest mobileRequest = EnrollMobileWalletRequest.builder()
    .indicatif("221")
    .numero("771234567")
    .refContributeur("REF_OPERATEUR_ORANGE_MONEY") // Référence de l'opérateur
    .build();

try {
    EnrollMobileWalletResponse response = sdk.wallets().enrollMobileWallet(mobileRequest);
    System.out.println("Compte Mobile Money enrôlé avec la référence : " + response.getReference());
} catch (ApiException e) {
    System.err.println("Échec de l'enrôlement : " + e.getResponseBody());
}

Exécuter un paiement (P2P)

import com.gimpaysdk.model.request.OperationRequest;
import com.gimpaysdk.model.enumeration.TypeOperation;
import com.gimpaysdk.model.response.OperationResponse;

OperationRequest p2pTransfer = OperationRequest.builder()
    .typeOperation(TypeOperation.P2P)
    .montant(5000.0)
    .libelle("Transfert pour achat de services")
    .refInstrumentPaiementInitiateur("REF_WALLET_SOURCE_123")
    .refInstrumentPaiementBeneficiaire("REF_WALLET_DEST_456")
    .build();

try {
    OperationResponse response = sdk.operations().execute(p2pTransfer);
    System.out.println("Transfert réussi. Référence de l'opération : " + response.getRefOperation());
} catch (ApiException e) {
    System.err.printf("Échec du transfert : Status=%d, Message=%s%n", e.getStatusCode(), e.getResponseBody());
}

Comprendre les modèles de données

Pour construire des requêtes complexes, il est essentiel de savoir quels champs sont disponibles et lesquels sont obligatoires.

Explorez les classes de requête : les objets de requête (par ex. OperationRequest, EnrollRequest) se trouvent dans le package com.gimpaysdk.model.request. Leurs Builder respectifs vous montrent tous les champs que vous pouvez définir.
Consultez la documentation de l’API : pour connaître les champs obligatoires pour un cas d’usage spécifique (par ex. un CASH_IN vs un P2P), référez-vous à la référence API GIMpay.

Valeurs et références

Certains appels nécessitent des valeurs spécifiques :

Enums : pour des valeurs comme le type d’une opération, utilisez les enums du package com.gimpaysdk.model.enumeration (par exemple TypeOperation.P2P).
Chaînes standardisées : pour des valeurs comme le type d’instrument ou les codes pays, référez-vous à la référence API et au glossaire pour la liste exhaustive.
Références d’entités : les identifiants uniques (REF_WALLET_..., REF_OPERATEUR_...) ne sont pas statiques, vous les obtenez via d’autres appels API. Par exemple, appelez sdk.wallets().getWallets() pour obtenir la référence d’un portefeuille, ou sdk.catalog().getContributors(...) pour celle d’un opérateur.

Flutter

Java

Initialisation

Services disponibles

Exemples d’utilisation

Consulter un solde

Enrôler un compte Mobile Money

Exécuter un paiement (P2P)

Comprendre les modèles de données

Valeurs et références

Étapes suivantes

Gestion des erreurs

Dépannage

​Initialisation

​Services disponibles

​Exemples d’utilisation

​Consulter un solde

​Enrôler un compte Mobile Money

​Exécuter un paiement (P2P)

​Comprendre les modèles de données

​Valeurs et références

​Étapes suivantes

Gestion des erreurs

Dépannage

Initialisation

Services disponibles

Exemples d’utilisation

Consulter un solde

Enrôler un compte Mobile Money

Exécuter un paiement (P2P)

Comprendre les modèles de données

Valeurs et références

Étapes suivantes