CardAcquisition

CardAcquisition is used to read card data from a card presented by the customer. Afterwards, based on the card data and a card reference provided in the CardAcquisition response, the following request types can be performed on the card.

Example request and response

All fields

These functions are described in separate sections.

Note

If no Payment or BalanceInquiry request is to be performed after a CardAcquisition request, the ECR must send an EnableService request with the TransactionAction component set to “AbortTransaction” to terminate the card processing and remove the card from the card reader.

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "CardAcquisition",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "CardAcquisitionRequest": {
      "SaleData": {
        "SaleTransactionID": {
          "TransactionID": "12345678",
          "TimeStamp": "2024-04-18T22:16:13.178+02:00"
        }
      },
      "CardAcquisitionTransaction": {
        "TotalAmount": 125.00,
        "AeCashBackAmount": 200,
        "PaymentType": "Normal",
        "AllowedPaymentBrand": [
          "VISA",
          "MASTERCARD"
        ],
        "AeAllowedPaymentBrandCategory": [
          "VOUCHER"
        ],
        "AeAccessibilityMode": true
      }
    }
  }
}

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "CardAcquisition",
      "MessageType": "Response",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "CardAcquisitionResponse": {
      "Response": {
        "Result": "Success",
        "AeResponseCode": "000"
      },
      "SaleData": {
        "SaleTransactionID": {
          "TransactionID": "12345678",
          "TimeStamp": "2024-04-18T22:16:13.178+02:00"
        },
        "AeHostToSaleData": "{\"AmountAndProductRestrictions\":{\"AcquirerResponseCode\": \"0\",\"MaxAmount\": 2000,\"ProductGroupsAllowed\": [100, 200]}}"
      },
      "POIData": {
        "POITransactionID": {
          "TransactionID": "87654321",
          "TimeStamp": "2024-04-18T22:16:13.478+02:00"
        }
      },
      "PaymentInstrumentData": {
        "PaymentInstrumentType": "Card",
        "CardData": {
          "PaymentBrand": "MASTERCARD",
          "MaskedPAN": "540481******1761",
          "SensitiveCardData": {
            "ExpiryDate": "2701"
          },
          "CardCountryCode": "578"
        }
      },
      "LoyaltyAccount": [
        {
          "LoyaltyBrand": "Rewards1",
          "LoyaltyAccountID": {
            "LoyaltyID": "LOYALTY1234567890"
          }
        }
      ]
    }
  }
}

Note

The AeHostToSaleData is a stringified JSON field used for passing data from the host to the ECR. Generally, there may be more than one JSON structure in the field, e.g. "{\"Structure1\":{\"DataElementList1\":[100, 200]},\"Structure2\":{\"DataElementList2\":[\"xxx\",\"yyy\",\"zzz\"]}}" Structures not relevant or not supported by the ECR must be ignored. The current structures are supported when applicable:

Currently supported keys

Get customer identity

To identify a customer the ECR can initiate a CardAcquisition request. If loyalty match, a customer id is included in the CardAcquisition response, see CardAcquisition.

If no Payment or BalanceInquiry request is initiated after the CardAcquisition request/response, the ECR must send an EnableService request with the TransactionAction component set to “AbortTransaction” to terminate the card processing and remove the card from the card reader.

Customer onboarding

Customer onboarding can be used to initiate an on-boarding process of a customer into the merchant's loyalty programme.

Initially, a CardAcquisition request is used to collect the customer identity. If there is no match, the cashier may ask the customer if he wants to become a member. If yes, the following steps are performed:

1. At the POI:

   • a. The customer is prompted in the terminal to accept the terms & conditions and to enter the mobile number

   • b. A payment is initiated (same as a normal payment, potentially with a discounted amount), alternatively an EnableService request is initiated to abort the transaction.

2. Afterwards, out of bounds:

   • a. The ECR sends the mobile number and the card reference collected in the CardAcquisition request to the loyalty programme system.

   • b. The loyalty programme system sends an SMS with an onboarding link to the customer.

   • c. Via the link, the customer onboards to the loyalty programme and is assigned a loyalty id.

   • d. The loyalty programme system sends an enrollment request, including the loyalty id and the CardAcquisition card reference, to Aera's loyalty lookup service.

   • e. The Aera lookup service enrolls the loyalty id and links it to the card used during the CardAcquisition.

For future payments using this card, the customer is recognised automatically via Aera's loyalty lookup service.

The terminal prompt for the mobile number uses the Input message.