Sync
Connectez des marchands qui possèdent déjà un compte Wajub et prélevez une commission.
Sync permet à une marketplace ou à une plateforme d'agir au nom des marchands avec lesquels elle travaille. Une connexion relie deux comptes Wajub : le vôtre, celui de la plateforme, et le leur, celui du marchand. Une fois la connexion live, vous appelez l'API classique avec un en-tête supplémentaire. La requête s'exécute alors comme si le marchand l'avait envoyée.
La première phrase est souvent mal comprise. Un compte connecté n'est pas un compte que vous créez. C'est un compte Wajub existant, détenu par un marchand qui se connecte et autorise votre plateforme. Vous créez l'invitation, puis il l'accepte.
1Un en-tête, un compte
X-Sync désigne le sous-compte sur un appel de paiement ordinaire, et Wajub applique la tarification propre à ce compte.
2La plateforme prend sa part
percentage_fee et fixed_fee sont définis sur le sous-compte, pas dans la requête. Aucune surcharge par appel n'est possible.
3Un paiement, un vendeur
Un panier avec deux vendeurs, ce sont deux paiements, chacun avec son en-tête. Rien ne répartit un paiement entre plusieurs comptes.
Ce qu'il vous faut avant de commencer
| Condition | Détail |
|---|---|
| Plan | Scale ou Enterprise. sync n'est pas inclus dans les plans inférieurs |
| Clé | La clé secrète de votre plateforme. Les routes de compte acceptent une clé publique, mais rien dans cette section ne doit être placé dans un navigateur |
| Marchand | Un compte Wajub existant ou une personne prête à en ouvrir un |
Sync dépend également d'un interrupteur global de la plateforme. S'il est désactivé, les routes
répondent 404 et la section disparaît de votre Dashboard, quel que soit votre plan.
Les quatre fonctions de Sync
Connecter un compte. Vous créez une connexion, transmettez un lien au marchand, puis celui-ci l'autorise depuis son propre Dashboard.
Vous prêter son identité. Avec X-Sync dans une requête, Wajub remplace le compte actif par
celui du marchand connecté. Le paiement, le client et le remboursement lui appartiennent.
Prélever votre commission. Chaque connexion possède des règles tarifaires. Lorsqu'un paiement attribué à cette connexion réussit, les frais sont calculés et crédités à votre plateforme.
Vous envoyer une copie de ses événements. Un paiement, un remboursement ou un transfert sur un compte connecté déclenche le webhook du marchand et envoie une deuxième copie aux endpoints de votre plateforme.
Ce que Sync ne fait pas
Un même paiement ne peut pas être réparti entre plusieurs comptes
Un paiement contient un seul en-tête X-Sync et appartient à une seule connexion. Aucun tableau
split ne répartit les fonds d'un même paiement entre plusieurs marchands. Un panier avec deux
vendeurs nécessite deux paiements. Paiements fractionnés décrit toute cette
limite, ainsi que l'autre fonctionnalité qui utilise le même terme.
Deux autres limites doivent être connues avant de concevoir votre système. Il n'existe aucun
endpoint de payout propre à une connexion. Pour payer un marchand, envoyez un
transfert classique avec l'en-tête X-Sync. Il utilise le solde du marchand,
pas le vôtre. De plus, les capacités sont figées dès la connexion du marchand, comme l'explique la
page des capacités.
L'en-tête en un seul endroit
Toutes les routes de cette section sont des routes classiques. Seul un en-tête change.
curl https://api.wajub.com/payments \
-H "Authorization: sk.kZ3qP8mWvL2xR7tB5nY4hC6dF9jS1aG0eU3i…" \
-H "X-Sync: acc_7Yh2MpL4tRb3nP8sZcXv" \
-H "Content-Type: application/json" \
-d '{
"amount": 50000,
"currency": "XAF",
"customer": { "email": "buyer@example.com" }
}'L'en-tête contient l'id de la connexion, la valeur renvoyée sous la forme account.id lors de sa
création. Ce n'est ni l'identifiant du compte du marchand ni l'une de vos clés.
X-Sync est lu sur toutes les routes authentifiées, pas seulement celles des paiements. Les clients,
remboursements, factures, transferts et liens de paiement l'acceptent, selon les capacités accordées.
Les ressources
| Méthode | Endpoint | Rôle |
|---|---|---|
POST GET | /accounts | Créer, répertorier et récupérer une connexion |
PUT DELETE | /accounts/{id} | Mettre à jour la tarification et le statut, ou déconnecter |
POST | /accounts/{id}/token | Générer un nouveau lien d'autorisation |
Tous les autres appels utilisent l'API classique avec l'en-tête.
Pages associées
- Démarrage rapideCréer une connexion, obtenir son autorisation et y recevoir un paiement.
- Capacités du compteLes onze capacités, celles qui sont appliquées et le calcul de la tarification.
- Intégration des marchandsLe cycle de vie d'une connexion et ce qui est figé après l'acceptation du marchand.
- Paiements fractionnésLes deux fonctionnalités qui utilisent le terme split et celle dont vous disposez réellement.
- Référence API des sous-comptesLa spécification de l'endpoint.