worldline Direct
S'inscrire

API endpoints et exemples de JSON

Chaque cas d'utilisation est lié à un JSON et à un point de terminaison API. Chaque JSON contient certaines propriétés pertinentes au COF. Trouvez une description détaillée dans le tableau dédié.

Google Pay prend en charge uniquement les cas A et E pour lesquels des différences s'appliquent. Consultez notre guide Google Pay dédié pour des exemples.

Exemple A

CreateHostedCheckout CreatePayment 
{
   "cardPaymentMethodSpecificInput":{
      "threeDSecure":{
         "challengeIndicator":"challenge-required",
         "skipAuthentication":false,
         "exemptionRequest":"none"
      },
      "tokenize":true,
      "recurring":{
         "recurringPaymentSequenceIndicator":"first"
      }
   },
   "hostedCheckoutSpecificInput":{
      "isRecurring":true,
      "locale":"en_GB"
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      }
   }
}
 
{
   "cardPaymentMethodSpecificInput":{
      "card":{
         "cardholderName":"Wile E. Coyote",
         "cardNumber":"4012000033330026",
         "expiryDate":"0530",
         "cvv":"123"
      },
      "paymentProductId":1,
      "tokenize":"true",
      "isRecurring":true,
      "recurring":{
         "recurringPaymentSequenceIndicator":"first"
      },
      "threeDSecure":{
         "challengeIndicator":"challenge-required",
         "redirectionData":{
            "returnUrl":"https://yourRedirectionUrl.com"
         }
      }
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      },
      "customer":{
         "device":{
            "acceptHeader":"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
            "browserData":{
               "colorDepth":99,
               "javaEnabled":true,
               "javaScriptEnabled":true,
               "screenHeight":"768",
               "screenWidth":"1024"
            },
            "ipAddress":"123.123.123.123",
            "locale":"en_GB",
            "userAgent":"Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/75.0.3770.142Safari/537.36",
            "timezoneOffsetUtcMinutes":"-180"
         }
      }
   }
}

Exemple B

CreateHostedCheckout CreatePayment en combinaison avec CreateHostedTokenization 
{
   "cardPaymentMethodSpecificInput":{
      "threeDSecure":{
         "challengeIndicator":"challenge-required",
         "skipAuthentication":false,
         "exemptionRequest":"none"
      },
      "tokenize":true,
      "unscheduledCardOnFileRequestor":"cardholderInitiated",
      "unscheduledCardOnFileSequenceIndicator":"first"
   },
   "hostedCheckoutSpecificInput":{
      "locale":"en_GB"
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      }
   }
}
 CreateHostedTokenization 
{
  "tokens": "VotreJeton"
}

CreatePayment 
{
   "cardPaymentMethodSpecificInput":{
      "card":{
         "cardholderName":"Wile E. Coyote",
         "cardNumber":"4012000033330026",
         "expiryDate":"0530",
         "cvv":"123"
      },
      "token",
      "paymentProductId":1,
      "unscheduledCardOnFileRequestor":"cardholderInitiated",
      "unscheduledCardOnFileSequenceIndicator":"first",
      "threeDSecure":{
         "challengeIndicator":"challenge-required",
         "redirectionData":{
            "returnUrl":"https://yourRedirectionUrl.com"
         }
      }
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      },
      "customer":{
         "device":{
            "acceptHeader":"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
            "browserData":{
               "colorDepth":99,
               "javaEnabled":true,
               "javaScriptEnabled":true,
               "screenHeight":"768",
               "screenWidth":"1024"
            },
            "ipAddress":"123.123.123.123",
            "locale":"en_GB",
            "userAgent":"Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/75.0.3770.142Safari/537.36",
            "timezoneOffsetUtcMinutes":"-180"
         }
      }
   }
}

Exemple C

CreateHostedCheckout CreatePayment en combinaison avec CreateHostedTokenization
C1) Sélection de la carte à utiliser sur le site du commerçant : 
{
  "cardPaymentMethodSpecificInput": {
      "token":"VotreJeton",
      "unscheduledCardOnFileRequestor":"cardholderInitiated",
      "unscheduledCardOnFileSequenceIndicator":"subsequent",
    "threeDSecure": {
      "challengeIndicator": "no-challenge-requested",
      "skipAuthentication": false,
      "exemptionRequest": "none"
    }
  },
  "hostedCheckoutSpecificInput": {
    "locale": "en_GB",
    "returnUrl": "https://yourReturnUrl.com"
  },
  "order": {
    "amountOfMoney": {
      "amount": 100,
      "currencyCode": "EUR"
    }
  }
}
C2: Sélection de la carte à utiliser sur Hosted Checkout Page 
{
   "cardPaymentMethodSpecificInput":{
      "threeDSecure":{
         "challengeIndicator":"no-challenge-requested",
         "skipAuthentication":false,
         "exemptionRequest":"none"
      },
      "unscheduledCardOnFileRequestor":"cardholderInitiated",
      "unscheduledCardOnFileSequenceIndicator":"subsequent"
   },
   "hostedCheckoutSpecificInput":{
      "locale":"en_GB",
      "returnUrl":"https://yourRedirectionUrl.com",
      "tokens":"VotreJeton1, VotreJeton2"
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      }
   }
}
 CreateHostedTokenization
{
  "tokens": "VotreJeton"
}
CreatePayment
{
   "cardPaymentMethodSpecificInput":{
      "token":"VotreJeton",
      "paymentProductId":1,
      "authorizationMode":"SALE",
      "unscheduledCardOnFileRequestor":"cardholderInitiated",
      "unscheduledCardOnFileSequenceIndicator":"subsequent",
      "threeDSecure":{
         "challengeIndicator":"no-challenge-requested",
         "redirectionData":{
            "returnUrl":"https://yourRedirectionUrl.com"
         }
      }
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      },
      "customer":{
         "device":{
            "acceptHeader":"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
            "browserData":{
               "colorDepth":99,
               "javaEnabled":true,
               "javaScriptEnabled":true,
               "screenHeight":"768",
               "screenWidth":"1024"
            },
            "ipAddress":"123.123.123.123",
            "locale":"en_GB",
            "userAgent":"Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/75.0.3770.142Safari/537.36",
            "timezoneOffsetUtcMinutes":"-180"
         }
      }
   }
}

Exemple D

SubsequentPayment

{
  "subsequentCardPaymentMethodSpecificInput": {
    "subsequentType": "installment"
  },
  "order": {
    "amountOfMoney": {
      "amount": 100,
      "currencyCode": "EUR"
    }
  }
}

Exemple E 

SubsequentPayment

{
  "subsequentCardPaymentMethodSpecificInput": {
    "subsequentType": "recurring"
  },
  "order": {
    "amountOfMoney": {
      "amount": 100,
      "currencyCode": "EUR"
    }
  }
}

Exemple F

SubsequentPayment

{
  "subsequentCardPaymentMethodSpecificInput": {
    "subsequentType": "unscheduled"
  },
  "order": {
    "amountOfMoney": {
      "amount": 100,
      "currencyCode": "EUR"
    }
  }
}

Exemple G / H / I / J 

SubsequentPayment

Remplissez "subsequentCardPaymentMethodSpecificInput.subsequentType" avec la valeur appropriée en fonction de votre cas d'utilisation. Retrouvez un aperçu de toutes les valeurs possibles dans ce chapitre.

{
  "subsequentCardPaymentMethodSpecificInput": {
    "subsequentType": "resubmission" / "partialShipment" / "delayedCharge" / "noShow"
  },
  "order": {
    "amountOfMoney": {
      "amount": 100,
      "currencyCode": "EUR"
    }
  }
}

Exemple X

Toute requête valide de CreateHostedCheckout/CreatePayment. Elle n'a pas besoin de contenir des propriétés pertinentes pour le COF. Retrouvez des exemples dans nos guides sur les méthodes de paiement, la Hosted Checkout Page et le guide sur Server-to-server.

Cette page vous a-t-elle été utile ?

Avez-vous des commentaires ?

Merci pour votre réponse.
Aide & Informations
Infos API
Outils de développement
© 2025 | Worldline | Terms of use | Notice relative à la vie privée | Notice relative aux cookies
New Feature

Try out our new chatbot and find answers to all your questions.