payone
Sign up

API endpoints and JSON samples

Each use case is linked to a JSON and a PAYONE E-Payment API endpoint. Each JSON contains certain COF-relevant properties. Find a detailed description in the dedicated table.

Sample A

CreateHostedCheckout CreatePayment 
{
   "cardPaymentMethodSpecificInput":{
      "threeDSecure":{
         "challengeIndicator":"challenge-required",
         "skipAuthentication":false,
         "exemptionRequest":"none"
      },
      "tokenize":true,
      "isRecurring":true,
      "recurring":{
         "recurringPaymentSequenceIndicator":"first"
      }
   },
   "hostedCheckoutSpecificInput":{
      "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"
         }
      }
   }
}

Sample B

CreateHostedCheckout CreatePayment in combination with 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": "YourToken"
}

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"
         }
      }
   }
}

Sample C

CreateHostedCheckout CreatePayment in combination with CreateHostedTokenization
C1) Selection of the card to use on the merchant site: 
{
  "cardPaymentMethodSpecificInput": {
      "token":"YourToken",
      "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: Selection on the card to use on 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":"YourToken1, YourToken2"
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      }
   }
}
 CreateHostedTokenization
{
  "tokens": "YourToken"
}
CreatePayment
{
   "cardPaymentMethodSpecificInput":{
      "token":"YourToken",
      "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"
         }
      }
   }
}

Sample D

SubsequentPayment

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

Sample E 

SubsequentPayment

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

Sample F

SubsequentPayment

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

Sample G / H / I / J 

SubsequentPayment

Populate "subsequentCardPaymentMethodSpecificInput.subsequentType" with the appropriate value depending on your use case. Find an overview of all possible values in this chapter.

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

Sample X

Any valid CreateHostedCheckout/CreatePayment request. It does not have to contain any of the COF-relevant properties. Find examples in our card payment method guides, the Hosted Checkout Page and Server-to-server guide.

Was this page helpful?

Do you have any comments?

Thank you for your response.
Help & Info
API Info
Developer Tools
Terms | Privacy |