Ces urls sont passées lors de la demande de transaction, et rappelée ensuite à la fin du processus de paiement.
| Code Block | ||||
|---|---|---|---|---|
| ||||
urls{
"succesreturn":"https://myProcessingServer.net/myApi/success.php?transId=95330876-67ae-4949-a11c-b9a29257831b",
"errorcancel":"https://myProcessingServer.net/myApi/cancel.php?transId=95330876-67ae-4949-a11c-b9a29257831b",
"webhook":"https://myBackOfficeServer.net/webhook.php"
} |
URL return & cancel
Elles sont renseignées lors de l'initialisation du paiement.
Il est conseillé d'ajouter à l'url un paramètre propre à votre back-office permettant de lier ce retour à la vente.
- url return: c'est le point d'entrée du commerçant pour finaliser la commande coté back-office marchant.
Cette url est appelé lorsque la transaction est finalisée avec succèsle client clic sur le bouton de validation à la fin du paiement. - url cancel: même principe que pour l'url return, cette url est appelée lorsque la transaction à été refuséele client clic sur le bouton cancel.
Une de ces deux url sera appelé à la fin du traitement bancaire de la transaction, afin de:
- Rediriger le client sur le site marchant a la fin de la transaction
- Informer le commerçant du statut de la transaction : validée ou non.
- de retourner au back-office du commerçant l'identifiant unique de la transaction payId générée par Axepta Online.
L'url appelé est celle passée, a laquelle est ajout le paramètre PayId portant la valeur du Payment Id généré par le serveur Axepta BNP Paribas Online pour cette transaction.
Exemple d'url appelé lors de la validation du paiement par le client.
en vert, l'url passée lors de l'initialisation du paiement, avec le transId ajouté pour lier le retour à un id marchand.
en rouge, le paramètre payId ajouté par le serveur.
https://myProcessingServer.net/myApi/success.php?transId=95330876-67ae-4949-a11c-b9a29257831b&PayId=b6eae9b16e3343fa90da39d4ee7bf4ad
Action à faire lors de la reception de ce message
Vous pouvez contacter le serveur Axepta BNP Paribas Online avec le paiement Id reçut en paramètre pour connaitre le statut de la transaction.
Utilisez l'api GET /payments/getByPayId/{payId}.
Eléments clés de la réponse à l'api getByPayId
- montant de la transaction
- autorisé
- capturé
- remboursé
- Identifiants de la transaction
- payId: id transaction Axepta BNP Paribas Online
- transId: id transaction Marchand
- xId: id action Axepta BNP Paribas Online
- refNr: numéro de reference de la transaction
- Status de la transaction
- status: Status de la transaction, succès (OK) ou en erreur (FAILED)
- responseCode: "000000000" si la transaction est réussi, un code erreur en cas d'echec.
(voir Response codes - Documentation pour le détail et la signification des différentes valeurs possibles.) - responseDescription: une phrase résumant l'état de la transaction.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"amount":{
"value":126,
"currency":"EUR",
"capturedValue":0,
"refundedValue":0
},
"payId":"91a6299a704147bf934aabd79fd1dc5d",
"merchantId":"MY_MERCHANT_ID",
"transId":"Trans361039",
"xId":"b55e68b7e4644a90836ae31effe1fc60",
"refNr":"refNb77254",
"status":"AUTHORIZED",
"responseCode":"00000000",
"responseDescription":"Transaction successful",
"paymentMethods":{
"type":"CARD"
}
} |
URL webhook
Cette adresse est appelée en dehors du processus de paiement.
C'est le mécanisme asynchrone utilisé par la plateforme Axepta BNP Paribas Online pour notifier le commerçant de la validation de la transaction.
Il est indispensable pour le site marchand de prendre en charge la réception de ce message.
C'est le seul accusé de complétion de transaction dont l'envoi est garanti.
Si le client ferme la fenêtre de navigation lors de la validation du paiement, l'appel a l'url return ou cancel ne sera pas fait.
Il n'est donc important pour le site marchant de traiter les requêtes reçues sur l'url webhook.
Le Serveur Axepta BNP Paribas Online retourne une payload json sur cette url à la fin de la transaction, avec les éléments clés suivant:
- montant autorisé
- le mechant Id utilisé
- Identifiants de la transaction
- payId: id transaction Axepta BNP Paribas Online
- transId: id transaction Marchand
- xId: id action Axepta BNP Paribas Online
- refNr: numéro de reference de la transaction
- Status de la transaction
- status: Status de la transaction, succès (OK) ou en erreur (FAILED)
- responseCode: "000000000" si la transaction est réussi, un code erreur en cas d'echec.
(voir Response codes - Documentation pour le détail et la signification des différentes valeurs possibles.) - responseDescription: une phrase résumant l'état de la transaction.
- la date de la transaction
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"merchantId": "YOUR_MERCHANT_ID",
"payId": "91a6299a704147bf934aabd79fd1dc5d",
"transId": "Trans361039",
"xid": "b55e68b7e4644a90836ae31effe1fc60",
"refNr": "refNb77254",
"status": "AUTHORIZED",
"responseCode": "00000000",
"responseDescription": "Transaction successful",
"amount": {
"value": 126,
"currency": "EUR"
},
"paymentMethods": {
"type": "CARD"
},
"creationDate": "2025-10-30T11:27:57Z",
"channel": "ECOM"
}
|