Traiter une autorisation
POST /cardpayments/v1/accounts/account_id/auths
Pour traiter une autorisation, vous devez initier une requête POST au point de terminaison auths.
Le paramètre settleWithAuth doit être défini sur « false » dans le corps de la requête.
Un montant est autorisé (le solde est retenu) sur la carte, et une requête ultérieure de règlement (saisie de fonds) sera nécessaire pour facturer le client et initier le transfert de fonds au marchand.
Le paiement fractionné ne peut pas être utilisé dans les autorisations qui ont settleWithAuth = false, lorsque l’intention est de régler l’achat ultérieurement. Dans ces situations, le paiement fractionné doit être utilisé dans la requête de règlement. Vous pouvez toutefois utiliser le paiement fractionné pour les achats lorsque l’autorisation et le règlement sont combinés (settleWithAuth=true).
Voir notre documentation API complète pour une description intégrale des paramètres requis pour la requête d’authentification.
curl -X POST https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H 'Content-Type: application/json' \
-d '{
"merchantRefNum": "authonlydemo-1",
"amount": 10098,
"settleWithAuth": false,
"card": {
"cardNum": "4111111111111111",
"cardExpiry": {
"month": 2,
"year": 2027
}
},
"billingDetails": {
"street": "100 Queen Street West",
"city": "Toronto",
"state": "ON",
"country": "CA",
"zip": "M5H 2N2"
}
}'
Par défaut, le système de traitement des cartes vérifie qu’il n’y a pas de transactions en double.
Avant d’essayer l’exemple, vous devez :
- Remplacer le numéro de compte (89987201) dans l’URL par le numéro de compte de test que vous avez reçu.
- Remplacer la clé API (après le -u) par la clé API que vous avez reçue.
- Fournir un numéro de référence unique pour chaque transaction.
La requête contient les paramètres suivants :
| Élément | Élément enfant | Type | Requis? | Description |
|---|---|---|---|---|
| merchantRefNum | string | Oui | Il s’agit du numéro de référence du marchand, créé par ce dernier, et soumis dans le cadre de la requête. Un numéro de référence unique du marchand doit être fourni pour chaque transaction. | |
| montant | integer max=99999999999 | Oui | Il s’agit du montant en unités mineures demandé pour cette autorisation. Utilisez le montant correct des unités mineures pour la devise du compte. Par exemple, pour traiter 10,99 $ US, cette valeur doit être 1099. Pour traiter 1 000 yens japonais, cette valeur doit être 1 000. Pour traiter 10 139 dinars tunisiens, cette valeur doit être 10139. | |
| settleWithAuth | boolean | No | Indique si la requête est une autorisation (pas de règlement) ou un achat (autorisation et règlement). La valeur par défaut est false. | |
| carte | cardNum | string | Oui | Il s’agit du numéro de carte utilisé pour la requête. |
| cardExpiry | object | Oui | Il s’agit de la date d’expiration de la carte. Les paramètres suivants sont requis :
| |
| billingDetails | street | string length<=50 | No | Il s’agit de la première ligne de l’adresse municipale figurant dans l’adresse de facturation. |
| city | string length<=40 | No | Il s’agit de la ville figurant dans l’adresse de facturation. | |
| state | string length<=40 | No | Il s’agit de la province ou de l’État ou de la province figurant dans l’adresse de facturation. | |
| country | string length=2 | No | Il s’agit du pays figurant dans l’adresse de facturation. | |
| zip | string length<=10 | No | Il s’agit du code postal de l’adresse de facturation. |
{
"links":[
{
"rel":"self",
"href":"https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths/6ce78961-5989-4c4b-ad68-5f5af506143e"
}
],
"id":"6ce78961-5989-4c4b-ad68-5f5af506143e",
"merchantRefNum":"authonlydemo-1",
"txnTime":"2014-05-05T12:28:20Z",
"status":"COMPLETED",
"amount":10098,
"availableToSettle":10098,
"card":{
"type":"VI",
"lastDigits":"1111",
"cardExpiry":{
"month":2,
"year":2027
}
},
"authCode":"118428",
"billingDetails":{
"street":"100 Queen Street West",
"city":"Toronto",
"state":"ON",
"country":"CA",
"zip":"M5H2N2"
},
"merchantDescriptor":{
"dynamicDescriptor":"Test",
"phone":"123-1234123"
},
"currencyCode":"CAD",
"avsResponse":"MATCH"
}
Les paramètres de réponse non inclus dans la requête initiale sont décrits ci-dessous :
| Élément | Élément enfant | Type | Description |
|---|---|---|---|
| links | tableau d’objets de lien | Contient un lien « self » qui peut être utilisé pour obtenir des détails sur l’autorisation. | |
| Id | string | Il s’agit de l’identifiant unique de l’opération d’autorisation. | |
| txnTime | string | Il s’agit de l’heure et de la date de la transaction au format TUC. | |
| status | enum | Il s’agit de l’état de l’autorisation. Les valeurs éventuelles sont :
| |
| availableToSettle | integer max=99999999999 | Il s’agit du montant disponible pour le règlement, en unités mineures. Si cette valeur est égale à 0, l’autorisation a été entièrement réglée (saisie). | |
| carte | type | enum | Il s’agit du numéro de carte utilisé pour la requête. Les valeurs éventuelles sont :
|
| lastDigits | string length=4 | Il s’agit des quatre derniers chiffres de la carte utilisée pour la requête. | |
| authCode | string length<=50 | Il s’agit du code d’autorisation renvoyé par la banque émettrice. | |
| merchantDescriptor | dynamicDescriptor | string | Il s’agit d’un descripteur de marchand qui sera affiché sur le relevé de carte du client. Vous pouvez soit envoyer cette information dans la requête, soit demander à Paysafe Group de configurer une valeur par défaut pour ce paramètre pour votre compte. |
| phone | string | Il s’agit du numéro de téléphone du marchand, qui sera ajouté au descripteur du marchand sur le relevé de carte du client. | |
| currencyCode | string length=3 | Il s’agit du code à trois chiffres de la devise. Il s’agit de la devise du compte marchand spécifiée dans le paramètre URL de la requête account_id lors de la création de cette autorisation. | |
| avsResponse | enum | Il s’agit de la réponse du service de vérification d’adresse (SVA) de l’émetteur de la carte :
L’adresse dans l’objet billingDetails de la requête est vérifiée par rapport à l’adresse que l’émetteur a dans ses dossiers pour la carte. |