Référence API

Démarrer le paiement du don

Initialise un don via la campagne Organisation et le service de paiement existant avec idempotence durable.

POSThttps://api.sparkglim.net/api/white-label/v1/fundraising/initialize

Modèle d’accès

Modèle d’accès: HMAC Organisation côté serveur
Portée requise: payments:write
Disponibilité documentée: Implémenté dans le code

La disponibilité est vérifiée dans le code, pas garantie en production.

La signature privée reste sur votre serveur. L’API Version 1 utilise le format de signature v2 ; ce n’est pas une API v2.

En-têtes

Nom	Type	Validation
`x-white-label-domain`Obligatoire Domaine vérifié qui résout le compte Organisation approuvé et lie cette requête.	`string`	Validation : Nom d’hôte HTTPS vérifié.
`x-white-label-key-id`Obligatoire Identifiant extrait de la clé privée unique ; n’envoyez jamais son secret dans cet en-tête.	`string`	Validation : Identifiant interne de la clé privée émise.
`x-white-label-signature-version`Obligatoire Sélectionne le format signé lié au domaine ; les routes API restent Version 1.	`string`	Validation : 2.
`x-white-label-timestamp`Obligatoire Heure de signature en millisecondes comparée à l’horloge serveur pour rejeter les requêtes périmées.	`string`	Validation : Millisecondes sur 13 chiffres ; dans une fenêtre de cinq minutes.
`x-white-label-nonce`Obligatoire Valeur aléatoire fraîche enregistrée par le serveur pour empêcher la répétition d’une requête signée.	`string`	Validation : Valeur nouvelle : 16–128 [A-Za-z0-9_-].
`x-white-label-signature`Obligatoire HMAC-SHA256 du domaine, clé d’idempotence, clé de campagne, horodatage, nonce, méthode, chemin, requête triée et empreinte exacte du corps.	`string`	Validation : HMAC-SHA256 hexadécimal en minuscules.
`x-white-label-campaign-key`Facultatif Clé de campagne complète facultative qui limite la requête privée à la même campagne autorisée.	`string`	Validation : Valeur keyId:secret complète, facultative et limitée à son périmètre.
`X-Idempotency-Key`Obligatoire Identité stable d’opération réutilisée avec les mêmes détails ; changer les détails avec la même clé est refusé.	`string`	Validation : 16–128 [A-Za-z0-9_-].

Requête

Nom	Type	Validation
`campaignId`Obligatoire Campagne existante dans le compte et dans tout périmètre de clé de campagne plus limité.	`string`	Validation : UUID.
`amount`Obligatoire Montant demandé dans la devise de campagne ou compte ; le serveur valide l’autorité financière et les conditions finales.	`number`	Validation : Valeur positive ; devise de campagne validée par le serveur.
`callbackUrl`Obligatoire Destination de retour acceptée par le contrat ; elle ne prouve jamais le succès d’un paiement.	`string`	Validation : URL.
`phoneNumber`Facultatif Téléphone du participant ; les moyens de paiement et règles peuvent exiger un numéro international valide.	`string\|null`	Validation : 8–32.
`email`Facultatif Email de contact utilisé par le parcours configuré ; il ne donne jamais accès à lui seul.	`string\|null`	Validation : Adresse e-mail.
`donorName`Facultatif Nom affiché du membre ou contributeur, sans modifier la propriété du compte.	`string\|null`	Validation : <=160.
`displayName`Facultatif Nom affiché du membre ou contributeur, sans modifier la propriété du compte.	`string\|null`	Validation : <=160.
`anonymous`Facultatif Demande le comportement de contribution anonyme existant ; évitez des champs contradictoires.	`boolean`	Validation : Valeur par défaut : false.
`message`Facultatif Message facultatif conservé avec le don selon la présentation autorisée.	`string\|null`	Validation : <=1000.
`channel`Facultatif Canal de livraison ou intégration pris en charge par cette opération et la configuration activée.	`enum`	Validation : web \| ussd \| telegram \| whatsapp.
`payment_channel`Facultatif Préférence facultative ; seuls les moyens activés pour le pays vendeur, la devise et le marchand sont utilisables.	`enum`	Validation : Méthode de paiement activée.
`metadata`Facultatif Métadonnées JSON supplémentaires acceptées ; elles ne remplacent jamais autorisation, prix ou propriété.	`object`	Validation : Objet JSON.

Requête

Les exemples décrivent le contrat et ne sont pas exécutés. Utilisez des données de test autorisées ; ne saisissez jamais de secret réel ici.

POST /api/white-label/v1/fundraising/initialize

http

POST /api/white-label/v1/fundraising/initialize HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
X-Idempotency-Key: example_stable_operation_0001
Content-Type: application/json

{
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "amount": 10,
  "callbackUrl": "https://events.example.com/payment-return",
  "anonymous": true
}

Réponse

Réponse de succès · HTTP 200

json

{
  "success": true,
  "data": {
    "authorization_url": "https://checkout.sparkglim.net/gh/<SERVER_REFERENCE>",
    "reference": "<SERVER_REFERENCE>"
  },
  "requestId": "wlapi_example"
}

Réponse d’erreur · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

Validation, permissions, données indisponibles et pannes utilisent le statut HTTP et l’erreur du gestionnaire.

Limites et tentatives

Limiteur Organisation : 120 requêtes par clé et 300 par IP par fenêtre ; respectez Retry-After et X-RateLimit.

Compatibilité du code

Les opérations autorisées nécessitent des tests propres au compte.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/auth.ts
server/src/white-label/schemas.ts
server/src/white-label/organization-service.ts
server/src/white-label/service.ts

Modèle d’accès

En-têtes

Requête

Requête

Réponse

Limites et tentatives

Compatibilité du code

Poursuivre le développement