Initialiser une demande de paiement simple

Pour initier un paiement simple, effectuez un appel au Web Service Charge/CreatePayment.

1. Utilisez les champs ci-dessous pour construire la requête :

   Nom du champ	Description	Requis
   formAction	Type de comportement souhaité lors de la création de la transaction. Doit être valorisé à PAYMENT.	Non
   amount	Montant à payer, exprimé dans sa plus petite unité monétaire.	Oui
   currency	Devise du paiement. Code ISO 4217 alpha-3. Ex: “XPF” pour le franc CFP.	Oui
   orderId	Référence de la commande. Ce champ est recommandé.	Non
   customer.email	Adresse e-mail qui sera utilisée pour l’envoi du ticket de paiement à l’acheteur. Ce champ est recommandé.	Non
   customer.reference	Identifiant de l’acheteur sur le site marchand. Ce champ est recommandé.	Non
   customer.billingDetails	Objet contenant le détail de l'adresse de facturation. Cet objet et ses attributs sont recommandés.	Non
   customer.shippingDetails	Objet contenant le détail de l'adresse de livraison. Cet objet et ses attributs sont recommandés.	Non
   customer.shoppingCart	Objet contenant le détail du panier. Cet objet et ses attributs sont recommandés.	Non
   transactionOptions.cardOptions.manualValidation	Mode de validation du paiement.	Non
   transactionOptions.cardOptions.captureDelay	Délai de remise.	Non

    Pour obtenir une description plus complète des champs à utiliser, testez le Web Service Charge/CreatePayment depuis notre playground.

   Exemple de requête

   POST https://api.secure.osb.pf/api-payment/V4/Charge/CreatePayment

   {
     "amount": 10000,
     "currency": "XPF",
     "formAction": "PAYMENT",
     "orderId": "CMD012859"
     "customer": {
       "reference": "104123487",
       "email": "sample@example.com",
         "billingDetails": {
         "category": "PRIVATE",
         "firstName": "Moana",
         "lastName": "Doom",
         "phoneNumber": "49123456",
         "cellPhoneNumber": "87123456",
         "streetNumber": "",
         "address": "Rue Gauguin",
         "zipCode": "98713",
         "city": "Papeete",
         "country": "PF",
         "language": "fr"
       },
       "shoppingCart": {
         "cartItemInfo": [
           {
             "productLabel": "La Végétarienne",
             "productType": "FOOD_AND_GROCERY",
             "productRef": "ZJJ5520",
             "productQty": 1,
             "productAmount": "1273"
           }
         ]
       },
       "shippingDetails": {
         "firstName": "Moana",
         "lastName": "Doom",
         "phoneNumber": "49123456",
         "address": "Bd de la Reine Pomare IV",
         "streetNumber": "8",
         "zipCode": "98714",
         "city": "Papeete",
         "country": "PF",
         "shippingMethod": "PACKAGE_DELIVERY_COMPANY"
       }
     }
   }

2. En réponse, le serveur marchand récupère un formToken, un objet encrypté permettant d’initialiser le formulaire embarqué avec les informations de la transaction et celles correspondant à la configuration de boutique.

   Exemple de réponse

   {
     "webService": "Charge/CreatePayment",
     "version": "V4",
     "applicationVersion": "5.25.0",
     "status": "SUCCESS",
     "answer": {
       "formToken": "02izOLcBypiLCJWSVNBX0RFQklUIiwiVklTQV...",
       "_type": "V4/Charge/PaymentForm"
     },
     "ticket": "111a64d6eb464bb8841f1c325af503af",
     "serverDate": "2021-06-29T12:37:33+00:00",
     "applicationProvider": "OSB",
     "metadata": null,
     "mode": "TEST",
     "serverUrl": "https://api.secure.osb.pf/",
     "_type": "V4/WebService/Response"
   }

3. Utilisez ensuite le formToken contenu dans la réponse pour faire afficher le formulaire embarqué sur votre page de paiement.
   
4. Une fois les données de la carte saisies, l'acheteur est invité à s'authentifier.
   
5. Après authentification, la plateforme procède à la demande d'autorisation puis l'acheteur est redirigé sur la page de succès ou de retour.