.
L'objet hook
L’objet hook permet de générer des évènements dits "Events". Ces événements sont adressés à votre système d’information selon l’état de l’objet avec lesquels ils interagissent.
Vous pouvez donc recevoir, sur votre infrastructure, des notifications HTTP que vous avez préalablement paramétrées pour un ou plusieurs points de vente.
À savoir que tous les objets de l’API sont disponibles dans les hooks.
En d’autres termes, à chaque interaction avec un objet suite à un changement de statut ou de donnée qui lui est envoyé, une requête HTTP sera adressée au serveur paramétré afin de vous avertir de l’opération qui est en train de se dérouler.
Par exemple, une transaction réussie ou échouée, la création d’une nouvelle souscription (abonnement), un nouveau client (Customer), un impayé...
Le serveur distant doit confirmer la bonne réception de la requête en retournant un code 2XX. Dans le cas contraire, une nouvelle requête sera adressée toutes les 5 min pendant 2h.
Les WEBHOOKS reflètent les modifications survenues sur les objets de l'API. Ils sont classés en deux catégories. Ceux appartenants aux Points de Vente "POS", et ceux appartenants aux "Comptes".
Probleme de reception des WebHook sur votre serveur
Pour vérifier la reception des hooks, nous vous conseillons d'utiliser le service http://webhook.site . Entrez l'url donnée par le site et l'adresse mail, et effectuez vos tests. Une fois que vous êtes satisfait des réponses hooks, vous pouvez remplacer l'addresse mail et l'url par les votre et réeffectuez un test.
WEBHOOKS liés aux "Point de Ventes"
L'object TRANSACTION
TRANSACTION_SUCCEEDED
Lorsqu'une transaction a été approuvée par la banque émettrice
TRANSACTION_CANCELED
Lorsqu'une transaction est annulée
TRANSACTION_CAPTURED
Lorsqu'une transaction est envoyée à la compensation et sera débitée
TRANSACTION_EXPIRED
Lorsqu'une transaction est expirée
TRANSACTION_UPDATED
Lorsqu'une transaction est mise à jour
TRANSACTION_DISPUTED
Lorsqu'une transaction est transformée en chargeback
TRANSACTION_FAILED
Lorsqu'une transaction a été refusée par la banque émettrice
TRANSACTION_FRAUDULENT
Lorsqu'une transaction est refusée car elle a rencontré un élément de liste noire (e-mail, IP, carte...)
TRANSACTION_NOT_ACCEPTED
Lorsqu'une transaction est refusée en raison de la saisie d'une règle d'acceptance
TRANSACTION_REFUNDED
Lorsqu'une transaction a été remboursée au titulaire de la carte
TRANSACTION_RISKY
Lorsqu'une transaction est refusée car son score de risque dépasse la limite
TRANSACTION_THREEDS_AUTH_FAILED
Lorsqu'une transaction est refusée car le titulaire de la carte n'a pas réussi à s'authentifier durant le processus 3DS
L'objet PAYMENTREQUEST
PAYMENTREQUEST_CREATED
Lorsqu'une payment request est créée
PAYMENTREQUEST_CANCELED
Lorsqu'une payment request est annulée
PAYMENTREQUEST_CLOSED
Lorsqu'une payment request est fermée
PAYMENTREQUEST_PAID
Lorsqu'une payment request est payée
PAYMENTREQUEST_INSTALLMENT_FAILED
Lorsqu'un installment d'une paymenrequest a échoué
PAYMENTREQUEST_INSTALLMENT_SUCCEEDED
Lorsqu'un installment d'une paymenrequest a réussi
PAYMENTREQUEST_SUBSCRIPTION_FAILED
Lorsqu'un abonnement d'une paymenrequest a échoué
PAYMENTREQUEST_SUBSCRIPTION_SUCCEEDED
Lorsqu'un abonnement d'une paymenrequest a réussi
PAYMENTREQUEST_TRANSACTION_FAILED
Lorsqu'une transaction d'une paymenrequest a échoué
PAYMENTREQUEST_TRANSACTION_SUCCEEDED
Lorsqu'une transaction d'une paymenrequest a réussi
PAYMENTREQUEST_WIRE_TRANSFER_SUCCEEDED
Lorsqu'un virement d'une paymenrequest a réussi
L'objet CREDIT
CREDIT_CREATED
Lorsqu'un crédit est créé
CREDIT_CANCELED
Lorsqu'un crédit est annulé
CREDIT_UPDATED
Lorsqu'un crédit est mis à jour
L'objet REFUND
REFUND_UPDATED
Lorsqu'un remboursement est mis à jour
REFUND_CANCELED
Lorsqu'un remboursement est annulé
L'objet DISPUTE
DISPUTE_UPDATED
Lorsqu'un impayé est mis à jour
RETRIEVAL_NOTICED
Lorsqu'une demande d'information vous est adressée
RETRIEVAL_CLOSE
Lorsqu'une demande d'information a été honorée de façon satisfaisante
CHARGEBACK_NOTICED
Lorsqu'un impayé vous est adressé par un client
CHARGEBACK_WON
Lorsqu'un impayé est rejeté
CHARGEBACK_LOST
Lorsqu'un impayé est confirmé
L'objet SDD TRANSACTION
MANDATE_CREATED
Lorsqu'un mandat est créé
MANDATE_SIGNED
Lorsqu'un mandat est signé
MANDATE_OBSOLETED
Lorsqu'un mandat est obsoléte
SDDTRANSACTION_CANCELED
Lorsqu'une SDD Transaction est annulée
SDDTRANSACTION_CLEARED
Lorsqu'une SDD Transaction est traitée
SDDTRANSACTION_CREATED
Lorsqu'une SDD Transaction est créée
SDDTRANSACTION_VALIDATED
Lorsqu'une SDD Transaction est validée
SDDTRANSACTION_RENEWOTP
Lorsqu'un OTP est renouvelé
BANKACCOUNT_ACCEPTED
Lorsqu'un compte en banque est accepté
L'objet SUBSCRIPTION
SUBSCRIPTIONMODEL_CREATED
Lorsqu'un modèle de subscription est créé
SUBSCRIPTIONMODEL_UPDATED
Lorsqu'un modèle de subscription est mis à jour
SUBSCRIPTION_CREATED
Lorsqu'une subscription est créée
SUBSCRIPTION_FAILED
Lorsqu'une subscription n'a pas pu être créée
SUBSCRIPTION_UPDATED
Lorsqu'une subscription est mise à jour
SUBSCRIPTION_CANCELED
Lorsqu'une subscription est annulée
SUBSCRIPTION_ACTIVE
Lorsqu'une subscription est activée
SUBSCRIPTION_FAILURE
Lorsqu'une subscription à échoué à être payé
SUBSCRIPTION_UNPAID
Lorsqu'une subscription n'est pas payée
SUBSCRIPTION_REACTIVATED
Lorsqu'une subscription est réactivée
INVOICEITEM_CREATED
Lorsqu'un invoiceItem est créé
INVOICEITEM_UPDATED
Lorsqu'un invoiceItem est mis à jour
INVOICEITEM_DELETED
Lorsqu'un invoiceItem est supprimé
INVOICE_CREATED
Lorsqu'un invoice est créé
INVOICE_UPDATED
Lorsqu'un invoice est mis à jour
INVOICE_CLOSED
Lorsqu'un invoice est fermé
INVOICE_REOPEN
Lorsqu'un invoice est réouvert
INVOICE_TRANSACTION_SUCCEEDED
Lorsque la transaction lié à un invoice est un succés
INVOICE_TRANSACTION_FAILED
Lorsque la transaction lié à un invoice a échoué
L'objet INSTALLMENT
INSTALLMENTPAYMENT_CREATED
Lorsqu'un paiement en X fois est créé
INSTALLMENTPAYMENT_FAILED
Lorsqu'un paiement en X fois n'a pas pu être créé
INSTALLMENTPAYMENT_UPDATED
Lorsqu'un paiement en X fois est mis à jour
INSTALLMENTPAYMENT_CANCELED
Lorsqu'un paiement en X fois est annulé
INSTALLMENTPAYMENT_ACTIVATED
Lorsqu'un paiement en X fois est activé
INSTALLMENTPAYMENT_FAILURE
Lorsqu'un paiement en X fois à échoué à être payé
INSTALLMENTPAYMENT_PAID
Lorsqu'un paiement en X fois à été payé
INSTALLMENTPAYMENT_UNPAID
Lorsqu'un paiement en X fois n'est été payé
INSTALLMENT_TRANSACTION_SUCCEEDED
Lorsqu'une transaction à été effectuée sur un paiement en X fois
INSTALLMENT_TRANSACTION_FAILED
Lorsqu'une transaction à été en échec sur un paiement en X fois
L'objet WIRETRANSFER (Deprecated)
WIRETRANSFER_CREATED
Lorsqu'un wireTransfer a été créé
WIRETRANSFER_UPDATED
Lorsqu'un wireTransfer a été mis à jour
WIRETRANSFER_RECEIVED
Lorsqu'un wireTransfer a été reçu
WIRETRANSFER_CANCELED
Lorsqu'un wireTransfer a été annulé
L'objet SCT Transaction
SCT_TRANSACTION_CREATED
Lorsqu'un SCT Transaction a été créé
SCT_TRANSACTION_UPDATED
Lorsqu'un SCT Transaction a été mis à jour
SCT_TRANSACTION_RECEIVED
Lorsqu'un SCT Transaction a été reçu
SCT_TRANSACTION_CANCELED
Lorsqu'un SCT Transaction a été annulé
SCT_TRANSACTION_REVERSAL_CREATED
Lorsqu'un SCT Transaction Reversal a été créé
SCT_TRANSACTION_REVERSAL_RECEIVED
Lorsqu'un SCT Transaction Reversal a été reçu
WEBHOOKS liés à un "Compte"
L'objet PAYOUT
PAYOUT_CREATED
Lorsque le paiement a été demandé. Vous recevrez :
{
"payoutId": "a6871574-5970-4af9-a271-f72097397038",
"creationDate": "2018-05-28T00:06:07.654084+02:00",
"merchantPayoutId": null,
"currency": "EUR",
"amount": 500000,
"destinationBankAccountId": "f72097397038-b286-421d-836d-e712ccef3faf",
"description": "Automatic Payout",
"status": "PENDING",
"cancellationDate": null,
"automatic": true,
"expectedArrivalDate": "2018-06-01",
"arrivalDate": null,
"payoutReference": "PAYOUT-1558908389270",
"walletId": "f72097397038-7696-43ac-9fd4-f72097397038",
"movementId": "f72097397038-400c-4dc8-bba2-f72097397038",
"cancelMovementId": null,
"additionalData": []
}PAYOUT_UPDATED
Lorsqu'un paiement en cours a été mis à jour
PAYOUT_CANCELED
Lorsqu'un paiement en cours a été annulé
PAYOUT_PAID
Lorsqu'un paiement en cours a été dûment exécuté
You'll receive :
{
"payoutId": "a6871574-5970-4af9-a271-f72097397038",
"creationDate": "2018-05-28T00:06:07.654084+02:00",
"merchantPayoutId": null,
"currency": "EUR",
"amount": 500000,
"destinationBankAccountId": "f72097397038-b286-421d-836d-e712ccef3faf",
"description": "Automatic Payout",
"status": "PAID",
"cancellationDate": null,
"automatic": true,
"expectedArrivalDate": "2018-06-01",
"arrivalDate": null,
"payoutReference": "PAYOUT-1558908389270",
"walletId": "f72097397038-7696-43ac-9fd4-f72097397038",
"movementId": "f72097397038-400c-4dc8-bba2-f72097397038",
"cancelMovementId": null,
"additionalData": []
}L'objet TRANSFER
TRANSFER_SUCCEEDED
Lorsqu'un transfer a réussi
TRANSFER_UPDATED
Lorsqu'un transfer a été mis à jour
TRANSFER_CANCELED
Lorsqu'un transfer a été annulé
L'objet TRANSFER REVERSAL
TRANSFERREVERSAL_SUCCEEDED
Lorsqu'un transferReversal a réussi
TRANSFERREVERSAL_UPDATED
Lorsqu'un transferReversal a été mis à jour
L'objet DEPOSIT
DEPOSIT_CREATED
Lorsqu'un deposit a été créé
DEPOSIT_UPDATED
Lorsqu'un deposit a été mis à jour
L'objet CUSTOMER
CUSTOMER_CREATED
Lorsqu'un customer a été créé
CUSTOMER_UPDATED
Lorsqu'un customer a été mis à jour
L'objet CARD
CARD_UPDATED
Lorsqu'une carte a été mise à jour
CARDTOKEN_CREATED
Lorsqu'un token de carte a été créé
ONBOARDING API
ONBOARDING_ENROLLMENT_CREATED
Lorsque la demande d'intégration a été acceptée. Vous recevrez un enrollementId associé à votre référence personnalisée
ONBOARDING_ENROLLMENT_STATUS_UPDATED
Un statut d'intégration a été mis à jour
ONBOARDING_ADDITIONAL_DOCUMENT_REQUESTED
Des documents supplémentaires ont été demandés pour l'enrollementID de l'intégration en cours
ONBOARDING_ENROLLMENT_INVALID_DOCUMENTS
Des documents du titulaire du compte ont été concidérés comme invalide par la conformité
ONBOARDING_ADDITIONAL_DOCUMENT_UPDATED
Des documents ou des informations supplémentaires ont été fournis par le titulaire du compte à un enrollementID de l'intégration en cours
ONBOARDING_ENROLLMENT_WORKFLOW_RESET
Le workflow est revenu à son état initial
ONBOARDING_PAYMENT_ACCOUNT_CREATED
The account has been created. You receive those elements
merchantBlockConfigurationStatus :
- NONE : Not blocked
- IN : Blocked in PAYIN
- OUT : Blocked in PAYOUT
- IN_OUT : Blocked in PAYIN and PAYOUT
merchantEnrollmentType :
- STANDARD : Direct merchant
- BASIC : Indirect merchant or participating merchant
Le compte a été créé. Vous recevrez ces éléments :
{
"merchantEnrollmentId": "b340efb5-c7d7-45e0-8e52-edb191a9228b",
"merchantEnrollmentCustomReference": "Batch OBD",
"merchantEnrollmentType": "STANDARD",
"merchantId": "027461c4-aec7-4e9d-bb48-b9149ea1620d",
"merchantName": "Batch OBD",
"merchantWalletId": "4bcd8945-a7e9-4cbc-b13e-487fc1da41d0",
"creationDate": "2022-02-28T09:41:05+0100",
"merchantBlockConfigurationStatus": "NONE"
}ONBOARDING_PEP_SANCTION_SEARCH_RESULT
Le compte a été vérifié concernant les Personnes exposées Publiquement
Les cas possibles :
* ACCEPTED : aucun hit PEP ou SANCTION sur la recherche. Le compte peut etre activé ou débloqué.
* NEED_MANUAL_VALIDATION : ce statut indique la présence d'un hit potentiel. Le service conformité de Centralpay est en cours d'analyse et de traitement du hit. Le compte est alors bloqué en PAY IN et PAY OUT en attendant le résultat de l'analyse.
* ACCEPTED_FALSE_POSITIVE : le hit est levé après vérification de la conformité. Ce statut intervient après le statut NEED_MANUAL_VALIDATION.
* REFUSED : Le Hit est confirmé. Le compte est refusé après analyse. Ce statut intervient après NEED_MANUAL_VALIDATION
* ACCEPTED_PEP : l'analyse confirme la présence d'une Personne Politiquement Exposée validée par le service conformité. Ce statut intervient également après le statut NEED_MANUAL_VALIDATION
{
"enrollment_uuid": "2c04dccb-8b11-4f1b-8a88-4a352c8f394c",
"enrollment_url": "https://backoffice.centralpay.net/admin/onboarding/2c04dccb-8b11-4f1b-8a88-4a352c8f394c/show",
"profile": {
"pep_validation": {
"created_at": "2023-12-08 11:30:23",
"status": "NEED_MANUAL_VALIDATION",
"reference": "1234567890-KOi5_uM5",
"client_ref": "2c41522c-04d8-4a84-aa39-85bec928c3c7",
"review_url": "https://app.eu.complyadvantage.com/app/case-management/search/1234567890-KOi5_uM5"
},
"sanction_validation": {
"created_at": "2023-12-08 11:30:23",
"status": "ACCEPTED",
"reference": "1234567890-KOi5_uM5",
"client_ref": "2c41522c-04d8-4a84-aa39-85bec928c3c7",
"review_url": "https://app.eu.complyadvantage.com/app/case-management/search/1234567890-KOi5_uM5"
}
}
}WEBHOOKS liés aux Payment Request
L'object PAYMENT REQUEST
PAYMENTREQUEST_CREATED
Lorsqu'une payment request à été créée
PAYMENTREQUEST_CANCELED
Lorsqu'une payment request à été annulée
PAYMENTREQUEST_CLOSED
Lorsqu'une payment request à été fermée
PAYMENTREQUEST_PAID
Lorsqu'une payment request à été payée
PAYMENTREQUEST_INSTALLMENT_FAILED
Lorsqu'un paiement en X fois d'une payment request n'a pas pu être créé
PAYMENTREQUEST_INSTALLMENT_SUCCEEDED
Lorsqu'un paiement en X fois d'une payment request a réussi
PAYMENTREQUEST_SUBSCRIPTION_FAILED
Lorsqu'une subscription d'une payment request n'a pas pu être créé
PAYMENTREQUEST_SUBSCRIPTION_SUCCEEDED
Lorsqu'une subscription d'une payment request a réussi
PAYMENTREQUEST_TRANSACTION_FAILED
Lorsqu'une transaction d'une payment request n'a pas pu être créé
PAYMENTREQUEST_TRANSACTION_SUCCEEDED
Lorsqu'une transaction d'une payment request a réussi
PAYMENTREQUEST_WIRE_TRANSFER_SUCCEEDED
Lorsqu'un wiretransfer d'une payment request a réussi