Point de terminaison d’API
Le point de terminaison d’API (URI ou URL) doit pointer vers l’environnement de test ou de production (en direct).
- Point de terminaison d’API de test : https://api.test.paysafe.com/
Par exemple : https://api.test.paysafe.com/cardpayments/monitor - Point de terminaison d’API de production : https://api.paysafe.com/
Par exemple : https://api.paysafe.com/cardpayments/monitor
Modèles de point de terminaison d’API
Les points de terminaison d’API se conforment généralement au modèle de l’exemple ci-dessous :
https://api.test.paysafe.com/cardpayments/v1/accounts/account_id/APIrequest
Remplacez les éléments de l’exemple de point de terminaison d’API ci-dessus par ce qui suit :
| Élément | Usage |
|---|---|
test | Utilisez test pour une transaction de test. Retirez le mot « test » pour une transaction réelle. |
| cardpayments | Remplacez par l’API que vous utilisez. Les valeurs éventuelles sont les suivantes :
|
| account_id | Remplacez par votre numéro de compte marchand unique, que vous recevez lorsque vous créez votre compte de test; vous trouverez les informations nécessaires dans le courriel. Vous pouvez également vous connecter au Portail Paysafe pour consulter la liste de vos comptes et des identifiants de compte connexes. Les marchands peuvent avoir plusieurs comptes, par exemple pour traiter des paiements dans différentes devises. Tous les comptes peuvent être configurés pour être utilisés avec la même clé API. |
| APIrequest | Remplacez par le type de requête API, comme les vérifications, les autorisations ou les règlements. |
| v1* | Il s’agit de la version de l’API. * Actuellement, toutes les API, à l’exception de 3D Secure 2, sont en version 1. Voir l’exemple de point de terminaison d’API 3D Secure 2 pour de plus amples renseignements. |
Le tableau ci-dessous donne d’autres exemples.
| Requête API | Utilisation | Modèle de point de terminaison |
|---|---|---|
Autorisations | Autoriser un paiement par carte Le montant autorisé est réservé sur la carte du client afin qu’il ne puisse pas être utilisé, mais il n’est pas déduit du compte du client. | POST/cardpayments/v1/accounts/account_id/auths |
| Vérifications | Vérifier que la carte est valide. Une autorisation pour un montant nul (zero auth) est obtenue. | POST/cardpayments/v1/accounts/account_id/verifications |
Annulation d’autorisation (également appelée autorisation renversée) | Annuler (renverser) une autorisation sur une carte. Les fonds réservés sont débloqués sur le compte du client. | POST/cardpayments/v1/accounts/account_id/auths/id/voidauths |
| Règlements | Saisir un montant qui a été précédemment autorisé sur la carte de crédit ou de débit d’un client. Vous pouvez saisir la totalité ou une partie d’une autorisation existante. Les fonds seront versés sur votre compte lors de la prochaine exécution par lot Paysafe. | POST/cardpayments/v1/accounts/account_id/auths/id/settlements |
| Annuler un règlement | Annule un règlement en attente. Notez que cette opération doit être effectuée avant la mise en lots de Paysafe, qui a généralement lieu en fin de journée. | PUT/cardpayments/v1/accounts/account_id/settlements/id |
Remboursements | Rembourser sur la carte de crédit ou de débit d’un client un montant qui a déjà été réglé. Les remboursements peuvent porter sur le montant total ou partiel de la transaction initiale. | POST/cardpayments/v1/accounts/account_id/settlements/id/refunds |
Crédits initiaux | Émettre des crédits aux titulaires de cartes sans nécessiter d’autorisation ou de règlement préalable. Peut être utilisé pour les paiements aux clients. | POST/cardpayments/v1/accounts/account_id/originalcredits |
Crédits autonomes | Émettre des crédits aux titulaires de cartes sans nécessiter d’autorisation ou de règlement préalable. Peut être utilisé pour les paiements aux clients. | POST/cardpayments/v1/accounts/account_id/standalonecredits |
- Dans les exemples ci-dessus, remplacez account_id par votre numéro de compte marchand unique et remplacez id par l’identifiant unique de la transaction initiale.
- Certains points de terminaison d’API comportent plusieurs paramètres. Par exemple, pour une requête d’annulation (renversement d’autorisation), account_id et id doivent être inclus.
- Les exemples renvoient au système de production.
Points d’extrémité d’API hérités
Nous recommandons aux clients qui utilisent les points d’extrémité d’API suivants de migrer vers les points de terminaison d’API Paysafe ci-dessus :
- Test : https://api.test.netbanx.com
- Production : https://api.netbanx.com