Utilisation des API CentralPay

L’API utilise un protocole HTTP pour transporter et renvoyer toutes les réponses formatées en JSON.
Les API CentralPay sont des API REST permettant de faciliter l’intégration de nos services de paiement.

CentralPay mets à disposition de ses utilisateurs deux API :

• L’API « Core Payment » : pour toutes les fonctions liées aux opérations de paiement
• L’API « Onboarding » : pour toutes les fonctions liées à la création de comptes de paiement et de monnaie électronique (accessibles aux partenaires uniquement)

1/ Fonctions

Toutes les fonctions utilisent les types « MIME » : « application/x-www-form-urlencoded » et « multipart/form-data ».

Les fonctions utilisent les méthodes suivantes :

• Méthode HTTP POST pour la création ou la mise à jour d’un objet
• Méthode HTTP GET pour la recherche d’objets
• Méthode HTTP DELETE pour supprimer des objets

2/ Authentification

L’API de CentralPay utilise l’authentification de base HTTP pour l’authentification. Toutes les demandes adressées à notre API doivent être authentifiées (intégrant le nom d’utilisateur et le mot de passe fournis par la plateforme) et doivent être effectuées via HTTPS.

Vous pouvez récupérer vos identifiants API depuis votre Portail utilisateur : Administration Mon compte Technique
Cliquez ensuite sur Identifiant API Modifier Générer Copiez le mot de passe API Mettre à jour

NB : Certains services comme le cardToken requièrent la déclaration de votre MerchantPublicKey, également disponibles depuis les liens présentés ci-dessus.

MerchantPublicKey

La MerchantPublicKey permet de s’authentifier sur le service API cardToken qui ne nécessite pas d’autre type d’authentification et permet d’identifier un marchand.
Cette clé est trouvable dans l’onglet Technique des détails de votre compte sur notre portail utilisateur :

3/ HTTP Request

Toujours utiliser HTTP-Header pour les formats de sérialisation (user_agent, …)

Le Content-Type (application/x-www-form-urlencoded ou multipart/form-data) doit être renseigné pour toutes les requêtes dans l’en-tête.

L’utilisation du champ « Idempotence-Key » dans l’en-tête HTTP permet d’identifier la requête qui a été envoyée.

Si la même valeur « Idempotence-Key » est envoyée à nouveau, la demande sera considérée comme déjà traitée et ne sera pas relancée.

Ce contrôle permet au commerçant d’éviter d’envoyer des entrées en double.

Cette clé doit être construite avec un hachage « sha1 » des paramètres de la demande (SANS date) concaténés comme ceci :

Idempotence-Key = sha1(card[number] + card[cvc] + card[expirationMonth] + card[expirationYear] + card[check] + merchantPublicKey)

NB : La clé "Idempotence-Key" est valable 24 heures.

4/ HTTP Response

Dans chaque réponse HTTP, le champ « Request-Id » est inscrit dans l’en-tête HTTP.

NB : Si vous avez une demande spécifique à envoyer via l'API REST de CentralPay, veuillez contacter le support ou votre référent CentralPay.