Point de terminaison d’API
Le point d’extrémité d’API (URI ou URL) doit pointer vers l’environnement de test ou de production (en direct).
- Point d’extrémité d’API de test : https://api.test.paysafe.com/
Par exemple : https://api.netbanx.com/hosted/monitor - Point d’extrémité d’API de production : https://api.paysafe.com/
Par exemple : https://api.netbanx.com/hosted/monitor
Modèles de point d’extrémité d’API
Les points d’extrémité de l’API sont conformes à ce modèle :
https://api.test.netbanx.com/hosted/v1/orders
Il se peut que vous deviez remplacer les éléments suivants :
| Élément | Usage |
|---|---|
test | Utilisez test pour une transaction de test. Retirez le mot test pour une transaction réelle. |
| v1 | Utilisé pour la version de l’API. |
Le tableau suivant répertorie les requêtes de l’API Paiements hébergés :
| Requête API | Utilisation | Modèle de point d’extrémité |
|---|---|---|
| Traiter une commande | Traiter une commande en utilisant la page de paiement hébergée. Options proposées :
| POST/hosted/v1/orders |
| Annuler une commande | Annuler une commande | DELETE/hosted/v1/orders/order_id |
| Annuler une commande en attente | Annuler une commande dont l’état de la transaction est en attente. | PUT/hosted/v1/orders/order_id |
| Renvoyer un rappel de commande | Déclencher le renvoi du rappel si, pour une raison quelconque, vous ne le recevez pas. | GET/hosted/v1/orders/order_id/resend_callback |
| Traiter une refacturation à l’aide d’un identifiant de commande | Procéder à une refacturation sur la carte de votre client, en utilisant l’identifiant d’une commande précédemment acceptée. La refacturation peut être immédiate ou être programmée pour une date ultérieure. | POST/hosted/v1/orders/order_id |
| Traiter une refacturation à l’aide d’un profil | Traiter une refacturation sur la carte de votre client, en utilisant un profil de client. | POST/hosted/v1/ordersorder_id |
| Obtenir l’état d’une commande | Obtenir l’état d’une requête de commande. | GET/hosted/v1/orders/order_id |
| Mettre à jour une commande en attente | Mettre à jour l’état de la transaction d’une commande qui est en attente, en indiquant qu’elle est réussie ou annulée. | PUT/hosted/v1/orders/order_id |
| Mettre à jour une commande de refacturation | Mettre à jour l’état de la transaction d’une commande de refacturation, lorsque la refacturation n’a pas encore été traitée. | PUT/hosted/v1/orders/order_id |
| Obtenir un rapport de commande | Obtenir une liste des commandes récemment créées ou traitées. | GET/hosted/v1/orders/orders?num=num&start=start |
| Rembourser une commande | Rembourser une commande qui a été traitée (c’est-à-dire lorsque les fonds ont été versés sur le compte du marchand). | POST/hosted/v1/orders/order_id/refund |
| Régler une commande | Régler une commande (saisir les fonds sur une autorisation initiale); utilisée par les marchands qui retardent le règlement jusqu’à ce que les produits ou services aient été livrés. | POST/hosted/v1/orders/order_id/settlement |
| Annuler un règlement | Annuler le règlement, si une requête de règlement a été envoyée mais que le montant n’a pas encore été réglé. | DELETE/hosted/v1/orders/order_id/settlement |
| Émettre un crédit initial | Émettre un crédit initial à l’aide d’un identifiant de commande | POST/hosted/v1/orders/order_id |
| Émettre un crédit initial à l’aide d’un profil | Émettre un crédit initial à l’aide d’un identifiant de profil | POST/hosted/v1/orders/order_id |
Dans les exemples ci-dessus, remplacez order_id par l’identifiant unique de la commande renvoyé lors de la configuration de la commande initiale.