Traiter un règlement
POST /cardpayments/v1/accounts/account_id/auths/authorization_id/settlements
Pour traiter un règlement, vous devez vous référer à l’identifiant d’autorisation d’origine et envoyer votre requête au point de terminaison du règlement.
Pour de plus amples renseignements sur l’utilisation des paiements fractionnés lors du règlement par carte, cliquez ici.
Voir notre documentation API complète pour une description intégrale des paramètres requis pour la requête de règlement.
curl -X POST https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths/6ce78961-5989-4c4b-ad68-5f5af506143e/settlements \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H 'Content-Type: application/json' \
-d ' {
"merchantRefNum": "settlementonlydemo-1"
}'
Avant d’essayer l’exemple, vous devez remplacer la clé API(après le -u) par la clé API que vous avez reçue.
Si vous n’indiquez pas de montant total pour le règlement, la totalité du montant restant sur l’autorisation sera définie par défaut.
La requête contient les paramètres suivants :
| Élément | 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. |
{
"links":[
{
"rel":"self",
"href":"https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/settlements/0fd73475-9837-4613-8464-355a3a99b8bb"
}
],
"id":"0fd73475-9837-4613-8464-355a3a99b8bb",
"merchantRefNum":"settlementonlydemo-1",
"txnTime":"2017-05-05T13:09:47Z",
"status":"PENDING",
"amount":10098,
"availableToRefund":10098
}
Un règlement en attente est créé. Pour la plupart des configurations de compte, le règlement reste en attente jusqu’à ce qu’il soit mis en lot à la fin de la journée. Vous pouvez annuler un règlement lorsqu’il a l’état en attente, auquel cas le client n’est pas facturé. Toutefois, une fois que le règlement a été mis en lot, vous ne pouvez pas l’annuler et vous devrez rembourser l’achat.
La réponse comporte les paramètres suivants :
| Élément | Type | Description |
|---|---|---|
| links | tableau d’objets de lien | Ce paramètre contient un lien « self » unique qui peut être utilisé pour obtenir des détails sur le règlement (saisie). |
| Id | string length<=36 | Il s’agit de l’identifiant unique du règlement (saisie). Cet identifiant peut être utilisé pour consulter les détails du règlement. |
| 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 du règlement. Les valeurs éventuelles sont :
|
| montant | integer max=99999999999 | Il s’agit du montant imputé, en unités mineures. |
| availableToRefund | integer max=99999999999 | Il s’agit du montant en unités mineures disponible pour le remboursement. Par exemple, le paramètre availableToRefund sera 0 si le règlement échoue (status=FAILED). Si le règlement aboutit, il sera égal au montant. |