Menu

Les objets de l'API

L’API est composée d’objets permettant de réaliser des opérations spécifiques en fonction des besoins. La liste complète est disponible ici https://ref-api.centralpay.net/.

Les objets les plus utilisés sont :

Cardtoken

Cardtoken est un objet qui représente la carte de paiement "tokenisée" (sous forme de jeton) qui sera utilisé pour initier une transaction.

Transaction

transaction permet de débiter votre client depuis son moyen de paiement, en général une carte de paiement, en utilisant le cardTokenID qui vient d’être créé ou depuis un customer si celui-ci a été précédemment enregistré. Lors d’une transaction réalisée avec un cardTokenID, un objet card est retourné sous forme de cardID.

Enrollment

enrollement permet de réaliser une transaction 3DS 1.0.

Card

Card représente la dématérialisation durable d’une carte de paiement. S’il est associé à un Customer, il peut permettre la mise en place d’un mode de paiement récurrent spécifique.

Customer

Un Customer représente votre client comme entité logique et permet de consolider l’ensemble de son activité.

Refund

Un refund représente un remboursement depuis une transaction existante. Cette fonction est accessible une fois la transaction en statut "cleared".

Subscription

Subscription permet de définir des cycles de paiements récurrents sous forme d’abonnement sur un de vos Customer. Ils se définissent en paramétrant un souscription model :

  • Interval unit (jour/ semaine / mois)
  • Interval count (distance entre deux interval count)
  • Interraction count (nombre de fois où le cycle est répété)

Installment payment

Il permet de découper un montant en plusieurs opérations selon un intervalUnit défini, une date de démarrage et d’éventuelles charges.

Vous pouvez ainsi gérer des séquences de paiement avec beaucoup d’agilité, par exemple :

100 euros à la commande lors de la transaction, puis 4 règlements de 300 euros pendant 4 mois à partir d’une date définie.

Les hooks

Ils permettent de générer des évènements dits "Events" qui seront adressés à votre système d’information selon l’état de l’objet avec lesquels ils interagissent.

Le moteur de règle d’acceptance

Si vous souhaitez encadrer le mode d’acceptation des opérations des transactions sur la "plateforme", vous pouvez utiliser le moteur de règle d’acceptance.

En fonction des données du contexte d’une transaction entrante (type de carte, montant, pays, devise, score anti-fraude), il est possible de choisir l’action à réaliser :

  • Refuser
  • Accepter
  • Demande d’OTP (code envoyé par email ou sms)
  • Demande de 3DS
  • Demande de 3DS conditionnel (transaction normale si la carte n’est pas 3DS)

Il existe plus d’une centaine de règles disponibles. Vous pouvez également intégrer des valeurs/données dans les règles et les appeler dans une transaction.

Payment claim

Une PaymentClaim est une demande de paiement qui sera adressée par email ou sms à un client pour régler une transaction.

Payment request

Une PaymentClaim est une demande de paiement évoluée associée à des scenarios d'envoie ou de relance. Elle permet le règlement d’une dette ou d’un projet en une ou plusieurs fois et depuis plusieurs participants

Smart Push

SMART PUSH est le service de notification et d'automatisation de CentralPay. Il permet d'émettre des notifications e-mail, SMS, HTTPS déclenchées depuis les étapes définies d'un scenario.

Transfer

Cet objet n’est utilisable que depuis un compte possédant l’habilitation "Plateforme". Il permet de répartir les fonds reçus pour un client depuis un compte "Plateforme" vers le compte "Basic" connecté selon des règles métiers spécifiques à la Plateforme.

Payout

Cet objet permet d’initier un virement externe vers un compte IBAN préalablement enregistré.

WireTransfer

Cet objet permet de paramétrer la réception de virements entrants afin de les adresser directement à un compte spécifique.