Classic-integration icon

Authorise using details stored with a third party

View source

This endpoint is inactive and is no longer supported for new integrations.

The Checkout API enables your online payments integration to accept all supported payment methods, use latest features, and access more benefits.

When you store payment details with a third party, you can use these details to authorise payments. 

Initial Card on file/Subscription payments

The following fields must be passed in a Card-on-File/Subscription payment request:

  • amount
  • shopperInteraction: set to Ecommerce for the initial payment or set to ContAuth for subsequent payments.
  • recurringProcessingModel: set to Subscription for payments that recur on a fixed schedule, and Card On File for payments that do not occur on a fixed schedule.
{
   "card":{
      "number":"4111111111111111",
      "expiryMonth":"8",
      "expiryYear":"2018",
      "cvc":"737",
      "holderName":"John Smith"
   },
   "amount":{
      "value":2000,
      "currency":"EUR"
   },
   "reference":"Your Reference Here",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "shopperEmail":"s.hopper@test.com",
   "shopperInteraction":"Ecommerce",
   "shopperIP":"61.294.12.12",
   "recurringProcessingModel":"Subscription"
}

Subsequent payments

{
   "card":{
      "number":"4111111111111111",
      "expiryMonth":"8",
      "expiryYear":"2018",
      "cvc":"737",
      "holderName":"John Smith"
   },
   "amount":{
      "value":2000,
      "currency":"EUR"
   },
   "reference":"Your Reference Here",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "shopperEmail":"s.hopper@test.com",
   "shopperInteraction":"ContAuth",
   "shopperIP":"61.294.12.12",
   "recurringProcessingModel":"Subscription"
}