Payment Account - Tokenized payment method

A Payment Account in apaleo refers to what is commonly refered to as Card on File, or a tokenized credit card, but it can also be other alternative payment methods that are tokenized. In apaleo they can be stored on a reservation or on a booking.

A Payment Account in apaleo means that a payment method has been authorized for recurring charges/payments. This is done for e-commerce by passing some specific details in the call to authorize.

Example for Adyen classic integration

Using endpoint /pal/servlet/Payment/v68/authorise

shopperReference is the unique identifier to use when storing this recurring authorization

The value of shopperReference is then what should be used when creating or updating a payment account in apaleo. In the apaleo API model for PaymentAccount it is refered to as the payerReference. This is illustrated well in the Creating a booking in apaleo example.

Important parameters:

  "shopperReference": "32ca2e32-6133-4afa-99da-5a0558075e49",
  "recurring": {
    "contract": "RECURRING"
  },
  "recurringProcessingModel": "UnscheduledCardOnFile",

Complete request example

{
  "amount": {
    "currency": "EUR",
    "value": 0
  },
  "reference": "Test20230316-2",
  "merchantAccount": "ApaleoGmbHUAT",
  "shopperInteraction": "Ecommerce",
  "shopperReference": "32ca2e32-6133-4afa-99da-5a0558075e49",
  "recurring": {
    "contract": "RECURRING"
  },
  "recurringProcessingModel": "UnscheduledCardOnFile",
  "card": {
    "cvc": "737",
    "expiryMonth": "03",
    "expiryYear": "2030",
    "holderName": "John Doe",
    "number": "4111111111111111"
  },
  "metadata": {
    "accountId": "DEMO",
    "propertyId": "JPOB"
  }
}

Example for Adyen Checkout integration

Using endpoint https://checkout-*/v69/payments

Important parameters:

   "shopperInteraction": "Ecommerce",
   "recurringProcessingModel": "UnscheduledCardOnFile",
   "storePaymentMethod": "true",

Complete request example

{
   "amount":{
      "value":0,
      "currency":"USD"
   },
   "paymentMethod":{
      "type":"scheme",
      "number":"4111111111111111",
      "expiryMonth":"10",
      "expiryYear":"2020",
      "cvc":"737",
      "holderName":"John Smith"
   },
   "reference":"YOUR_ORDER_NUMBER",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
   "shopperInteraction": "Ecommerce",
   "recurringProcessingModel": "UnscheduledCardOnFile",
   "storePaymentMethod": "true",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "returnUrl":"https://your-company.com/..."
}