Skip to main content

​
Intégration API

La fonctionnalité sous-marchands utilise l’API HUB2. Les points de terminaison disponibles sont listés dans la documentation suivante :

API Sous-marchand

​
Authentification

Votre intégration utilise les mêmes clés API HUB2 pour l’authentification. La clé doit disposer des permissions suivantes :
  • Api.submerchant_create
  • Api.submerchant_list
  • Api.submerchant_update
Pour traiter des paiements ou des transferts pour un sous-marchand, la même clé doit aussi disposer des permissions de paiement et de transfert que vous utilisez déjà (par exemple Api.payment_intent_create, Api.transfer_create).

Configuration des permissions

​
Points de terminaison de l’API

​
Sous-marchands

  • POST /submerchants : créer un sous-marchand. name et description sont obligatoires ; address, zipcode, city, phoneNumber et legalInfo sont facultatifs. Exemple :
  • PATCH /submerchants/{submerchantId} : mettre à jour un sous-marchand
  • GET /submerchants : lister vos sous-marchands
Limites de flux : GET /submerchants est limité à 1 requête par 5 secondes. POST /submerchants et PATCH /submerchants/{submerchantId} sont limités à 1 requête par seconde. Au-delà de ces limites, l’API répond HTTP 429 Too Many Requests.
La réponse contient l’id du sous-marchand. Conservez-le pour traiter des transactions pour le compte du sous-marchand.

​
Transactions pour un sous-marchand

Pour créer un paiement ou un transfert pour un sous-marchand, appelez les points de terminaison de paiement ou de transfert habituels avec votre propre clé API et renseignez l’id du sous-marchand dans l’en-tête MerchantId. La transaction est enregistrée pour le sous-marchand et son champ subMerchantId est renseigné. Un marchand parent qui appelle les points de terminaison de transaction avec son propre MerchantId reçoit une erreur 403 avec le code group_owner_transaction_forbidden. Renseignez toujours l’id du sous-marchand dans l’en-tête MerchantId.

​
Webhooks

Les paiements et transferts effectués pour un sous-marchand utilisent les webhooks standard de paiement et de transfert. Si vous les avez déjà configurés, aucune étape supplémentaire n’est requise. Sinon, consultez :

Guide d'intégration des webhooks