Search Overlay

Traiter une commande à l’aide d’une page hébergée

POST /hosted/v1/orders

Pour traiter une commande à l’aide d’une page de paiement hébergée par Paysafe, vous devez d’abord créer (ou enregistrer) une commande dans le système en envoyant une requête POST au point d’extrémité des commandes. La requête est exécutée lorsque le montant total, la devise et la référence du marchand ont été déterminés. Par défaut, la requête de commande est un achat, dans lequel le montant est à la fois autorisé et réglé dans la même requête.

Exemple de requête

Voici un exemple de commande simple :

curl -X POST -H "Content-Type: application/json" \
-u jTxL2wsNysJ8Jzmpdwim:NAA043a7c53c66ac3826c5e \
https://api.test.netbanx.com/hosted/v1/orders \
-d ’{
"merchantRefNum" : "ABCDE12345",
"currencyCode" : "GBP",
"totalAmount" : 1000
}’

Exemple de réponse

Une requête de commande réussie donne lieu à une réponse dont la structure est la suivante :

{

"currencyCode" : "GBP",
"id" : "25TWPTLHRR81AIG1LF",
"link" : [
{
"rel" : "hosted_payment",
"uri" : "https://api.test.netbanx.com/hosted/v1/payment/53616c7465645f5fc96311a769ed171ce70fac1483fa7f6d9ecfb6d427c1e12c6fc573a35f13e0ea"
},
{
"rel" : "self",
"uri" : "https://jTxL2wsNysJ8Jzmpdwim:NAA043a7c53c66ac3826c5e@api.test.netbanx.com/hosted/v1/orders/25TWPTLHRR81AIG1LF"
}
],
"merchantRefNum" : "ABCDE12345",
"mode" : "live",
"totalAmount" : 1000,
"type" : "order"

}

Cette réponse confirme que le système Paysafe a accepté votre commande et est prêt à traiter le paiement. Elle contient des informations de base sur la commande reçue, y compris currencyCode, merchantRefNum, totalAmount, et l’id de la commande, qui est la référence unique que le système Paysafe a attribuée à votre requête de commande. Vous pouvez utiliser cet identifiant pour obtenir des informations sur votre commande à tout moment. La réponse à la commande vous fournit également un ensemble de liens. Chaque lien contient un type et une valeur href (l’URL du lien). Le premier lien fait référence à l’URL hosted_payment – il s’agit de l’URL de la page de paiement. Votre système doit extraire cette URL de la commande et l’utiliser pour rediriger votre client vers la page de paiement hébergée, où il peut saisir les détails de son paiement. Voici un exemple : Un second lien, self, est l’URL à appeler pour connaître l’état de la transaction.

Exemple de page de paiement hébergée

L’exemple suivant de page de paiement hébergée a été généré à partir d’une demande contenant plus de paramètres que dans l’exemple de code ci-dessus. Pour plus de détails sur tous les paramètres de demande et de réponse, voir la description de l’objet de commande.

L’URL de cette page est renvoyée dans le lien hosted_payment.

Exemples de pages personnalisées

Communiquez avec notre équipe du soutien technique pour en savoir plus sur le service de personnalisation de la page de paiement hébergée. Des frais supplémentaires peuvent s’appliquer.

Caractéristiques de la commande en option

Vous pouvez éventuellement ajouter les caractéristiques suivantes à une commande en utilisant les paramètres de l’objet Commande :

  • Notifications par courriel au client
  • Notifications par courriel au marchand
  • Emplacement

Notifications par courriel au client

Les notifications par courriel au client sont entièrement localisées et personnalisées; veuillez contacter les services au marchand pour de plus amples renseignements.

Pour envoyer un courrier électronique de notification au client, transmettez le paramètre customerNotificationEmail lors de l’étape de création de la commande comme suit :

{
"customerNotificationEmail" : "jane.smythe@emailhost.com"
}

Pour éviter l’envoi d’une notification par courriel au client, envoyez le champ suppressCustomerEmail (extendedOption) avec la valeur définie sur true.

Notifications par courriel au marchand

Pour envoyer un courrier électronique de notification au marchand, transmettez le paramètre merchantNotificationEmail lors de l’étape de création de la commande comme suit :

{
"merchantNotificationEmail" : "merchant@emailhost.com"
}

Emplacement

L’API Paiements hébergés prend en charge la localisation des pages et des courriels contenant des informations sur les paiements et les reçus. Le système tente d’établir la meilleure correspondance possible avec les informations contenues dans le paramètre locale.

REMARQUE : Si le paramètre locale n’est pas transmis, ou si un code ISO 639-1 non pris en charge est envoyé à l’API, la valeur par défaut dans la configuration de l’intégration du marchand est utilisée.

Pour ajouter des informations sur la l’emplacement à la commande, transmettez le paramètre locale comme suit :

{
"locale" : "en_GB"
}

Les valeurs du paramètre locale suivantes sont prises en charge.

  • en_US
  • en_GB
  • fr_FR
  • fr_CA

Caractéristiques de la commande en option

Vous pouvez éventuellement ajouter les caractéristiques suivantes à une commande en utilisant les paramètres de l’objet Commande :

  • Notifications par courriel au client
  • Notifications par courriel au marchand
  • Emplacement

Notifications par courriel au client

Les notifications par courriel au client sont entièrement localisées et personnalisées; veuillez contacter les services au marchand pour de plus amples renseignements.

Pour envoyer un courrier électronique de notification au client, transmettez le paramètre customerNotificationEmail lors de l’étape de création de la commande comme suit :

{
"customerNotificationEmail" : "jane.smythe@emailhost.com"
}

Pour éviter l’envoi d’une notification par courriel au client, envoyez le champ suppressCustomerEmail (extendedOption) avec la valeur définie sur true.

Notifications par courriel au marchand

Pour envoyer un courrier électronique de notification au marchand, transmettez le paramètre merchantNotificationEmail lors de l’étape de création de la commande comme suit :

{
"merchantNotificationEmail" : "merchant@emailhost.com"
}

Emplacement

L’API Paiements hébergés prend en charge la localisation des pages et des courriels contenant des informations sur les paiements et les reçus. Le système tente d’établir la meilleure correspondance possible avec les informations contenues dans le paramètre locale.

REMARQUE : Si le paramètre locale n’est pas transmis, ou si un code ISO 639-1 non pris en charge est envoyé à l’API, la valeur par défaut dans la configuration de l’intégration du marchand est utilisée.

Pour ajouter des informations sur la l’emplacement à la commande, transmettez le paramètre locale comme suit :

{
"locale" : "en_GB"
}

Les valeurs du paramètre locale suivantes sont prises en charge.

  • en_US
  • en_GB
  • fr_FR
  • fr_CA