CardAcquisition Request

It conveys Information related to the payment and loyalty cards to read and analyse. This message pair is usually followed by a message pair (e.g. payment or loyalty) which refers to this Card Acquisition message pair. Content of the Card Acquisition Request message.

Request Parameters

Required

Optional

Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.

Show children

Identification of the Cashier or Operator.

Language of the Cashier or Operator. If different from the Login.

Shift number. If different from the Login, see Login SaleData.

Identification of a transaction for the Sale System or the POI System.

Show children

Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.

Information related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.

Show children

Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

Customer
Transaction

Additional and optional identification of a customer order.

List of customer order open, closed or both to be sent in the response messages. Possible values:

Both
Closed
Open

Sale information intended for the POI. Stored with the transaction.

Sale information intended for the Acquirer. Send to the Acquirer if present.

Sale information intended for the Issuer. The POI System receives this information and sends it to the Acquirer for the Issuer without any change.

Show children

Data related to the payment and loyalty card acquisition.

Show children

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200
It conveys Information related to the payment and loyalty cards read and processed by the POI System and entered by the Customer. Content of the Card Acquisition Response message.
Show moreShow less
Responseobject
Result of a message request processing. If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements.
Show children Hide children
Resultstring
Result of the processing of the message. Possible values:

Failure

Partial

Success

ErrorConditionstring
Condition that has produced an error on the processing of a message request. Returned if Result is not Success. Possible values:

Aborted

Busy

Cancel

DeviceOut

InProgress

InsertedCard

InvalidCard

LoggedOut

MessageFormat

NotAllowed

NotFound

PaymentRestriction

Refusal

UnavailableDevice

UnavailableService

UnreachableHost

WrongPIN

AdditionalResponsestring
Additional information related to processing status of a message request. If present, the POI logs it for further examination.
SaleDataobject
Data associated with the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition.
Show children Hide children
OperatorIDstring
Identification of the Cashier or Operator.
OperatorLanguagestring
Language of the Cashier or Operator. If different from the Login.
ShiftNumberstring
Shift number. If different from the Login, see Login SaleData.
SaleTransactionIDobject
Identification of a transaction for the Sale System or the POI System.
Show children Hide children
TransactionIDstring
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstring
Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.
SaleReferenceIDstring
Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
SaleTerminalDataobject
Information related to the software and hardware features of the Sale Terminal. Sent in the Login Request if a Sale Terminal is involved in the login. In other messages, sent when a logical device is out of order (SaleCapabilities) or when other data have changed or were missing in the Login.
Show children Hide children
TotalsGroupIDstring
Identification of a group of transactions on a POI Terminal, having the same Sale features. Could be used to group POI for reconciliation or other purpose defined by the Sale System. The default value is assigned by the Login Request.
TokenRequestedTypestring
Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

Customer

Transaction

CustomerOrderIDstring
Additional and optional identification of a customer order.
CustomerOrderReqarray[string]
List of customer order open, closed or both to be sent in the response messages. Possible values:

Both

Closed

Open

SaleToPOIDatastring
Sale information intended for the POI. Stored with the transaction.
SaleToAcquirerDatastring
Sale information intended for the Acquirer. Send to the Acquirer if present.
SaleToIssuerDataobject
Sale information intended for the Issuer. The POI System receives this information and sends it to the Acquirer for the Issuer without any change.
Show children Hide children
StatementReferencestring
Label to print on the bank statement.
POIDataobject
Data related to the POI System. In the Message Response, identification of the POI transaction.
Show children Hide children
POITransactionIDobject
Identification of a transaction for the Sale System or the POI System.
Show children Hide children
TransactionIDstring
Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
TimeStampstring
Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.
POIReconciliationIDinteger
Identification of the reconciliation period between Sale and POI. If Result is Success.
PaymentBrandarray[string]
Type of payment card. Brands available for payment by the card and not chosen by the Customer.
PaymentInstrumentDataobject
Data related to the instrument of payment for the transaction. Sent in the result of the payment transaction. For a card, it could also be sent in the CardAcquisition response, to be processed by the Sale System.
Show children Hide children
PaymentInstrumentTypestring
Type of payment instrument. Possible values:

Card

Cash

Check

Mobile

StoredValue

ProtectedCardDatastring
Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
CardDataobject
Information related to the payment card used for the transaction. Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition, or BalanceInquiry request to the POI. It can also be sent in the CardAcquisition response, to be processed by the Sale System.
Show children Hide children
PaymentBrandstring
Type of payment card. If card PAN is readable. Indicates the card used to pay in the PaymentResponse. Sent in the CardAcquisitionResponse, to leave the Cashier to choose between several applications in a smartcard, or several brand in a co-branded card. In this case, the CardAcquisitionRequest.ForceCustomerSelectionFlag must contain the value False. Brands are part of the POI and Sale Systems configurations.
MaskedPanstring
Masked Primary Account Number Part of the PAN is replaced by a string of * characters, to identify a customer account or relationship. Presence of this data element, which replace the PAN when SensitiveCardData is protected and replaced by ProtectedCardData. Alternatively the MaskedPAN can be used as a token to identify a customer.
PaymentAccountRefstring
Reference of the PAN, which identifies the PAN or the card uniquely, named also PAR (Payment Account Reference). This reference may be defined by the card issuer or by a token service provider under the control of the card issuer, and cannot be used for a payment transaction.
EntryModearray[string]
Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values:

Contactless

File

ICC

Keyed

MagStripe

Manual

Mobile

RFID

Scanned

SynchronousICC

Tapped

CardCountryCodeinteger
Minimum: 3Maximum: 3
Country Code attached to the card (3 numerics). If available in the card.
ProtectedCardDatastring
Sensitive information related to the payment card, protected by CMS. SensitiveCardData protected by CMS EnvelopedData.
SensitiveCardDataobject
This data structure could be CMS protected (EnvelopedData). In this case the data structure SensitiveCardData is replaced by the data structure ProtectedCardData of type ContentInformationType. When this data is protected, the exact content is unknown by the Sale System, and might include all the information which are required by an external backup POI Server to make a batch payment transaction in case of problem with the POI System. Sensitive information related to the payment card, entered or read by the Sale System.
Show children Hide children
PANinteger
Minimum: 8Maximum: 28
Primary Account Number.
CardSeqNumbinteger
Minimum: 2Maximum: 3
Card Sequence Number. If EntryMode is File, Keyed, or Manual.
ExpiryDateinteger
Minimum: 4Maximum: 4
Date after which the card cannot be used. If EntryMode is File.
TrackDataarray[object]
Magnetic track or magnetic ink characters line. If EntryMode is MagStripe or RFID .
Show children Hide children
TrackNumbinteger
Minimum: 1Maximum: 3
Card track number.
TrackFormatstring
Magnetic track or magnetic ink characters line. Possible values:

AAMVA

ISO

TrackValuestring
Card track content.
AllowedProductCodearray[integer]
Product codes that are payable by the payment card. If not all the products are accepted for the payment card proposed by the Customer. In this case, Result is failure, ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success. Product codes that are payable by the payment card. If all the products are not accepted for the payment card proposed by the Customer. In this case, Result is failure and ErrorCondition is Payment Restriction. For One Time Reservation, the POI can send product codes payable by the payment, even if the POI did not send SaleItem in the request. If at least one product sent in the request is accepted, the Result is Success.
AllowedProductarray[object]
Product that is payable by the payment card.
Show children Hide children
ProductCodeinteger
Minimum: 1Maximum: 20
Product code of item purchased with the transaction.
EanUpcinteger
Standard product code of item purchased with the transaction.
ProductLabelstring
Product name of an item purchased with the transaction.
AdditionalProductInfostring
Additionl information related to the line item.
PaymentTokenobject
Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer.
Show children Hide children
TokenRequestedTypestring
Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values:

Customer

Transaction

TokenValuestring
Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
ExpiryDateTimestring
Expiry date and time. Limits the validity of a payment token.
CustomerOrderarray[object]
Customer order attached to a customer, recorded in the POI system. Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.
Show children Hide children
CustomerOrderIDstring
Additional and optional identification of a customer order.
SaleReferenceIDstring
Identification of a Sale global transaction for a sequence of related POI transactions. Identification of a reservation transaction for the sequence of reservation and the completion.
OpenOrderStateboolean
Specifies if a customer order is currently Open. An open customer order is an order waiting for further operations.
StartDatestring
Date time of the beginning of an operation.
EndDatestring
Date time of the end of an operation.
ForecastedAmountnumber
Maximum: 99999999.999999
Depending on the choice of the sale system it could equal the initial amount of the order or the global amount of the order. If ForecastedAmount equals the initial amount of the order it will allow the system to follow any additional payment. In case of equality with the global amount of the order, the system will then be able to follow remaining amounts.
CurrentAmountnumber
Maximum: 99999999.999999
Total amount of all completed transactions of a customer order.
Currencystring
Currency of a monetary amount.
AccessedBystring
Identification of an entity accessing data to perform an operation. Allow the synchronisation of customer order processing, when several parts of the Sale System access a customer order at the same time. The Sale entity active on the customer order is identified by this data.
AdditionalInformationstring
Unqualified information.
CheckDataobject
Information related to the paper check used for the transaction. Allows the check information to be provided by the Sale System before requesting the payment, or stored by the Sale System after processing of the payment.
Show children Hide children
BankIDstring
Identification of the bank. Mandatory if TrackData absent.
AccountNumberstring
Identification of the customer account. Mandatory if TrackData absent.
CheckNumberstring
Identification of the bank check. Mandatory if TrackData absent.
TrackDataobject
Magnetic track or magnetic ink characters line. ISO 7813 - ISO 4909. Generic data structure for a card track, used when the magstripe card reader is located on the Sale Terminal, or for magstripe Card Reader device request. The data structure is also used to store the line at the bottom of a bank check.
Show children Hide children
TrackNumbinteger
Minimum: 1Maximum: 3
Card track number.
TrackFormatstring
Magnetic track or magnetic ink characters line. Possible values:

AAMVA

ISO

TrackValuestring
Card track content.
CheckCardNumberstring
Check guarantee card number. If provided by the customer.
TypeCodestring
Type of bank check. Possible values:

Company

Personal

Countrystring
Country of the bank check. Absent if country of the Sale system.
MobileDataobject
Mobile phone is used as a payment instrument for the transaction. Information related to the mobile for the payment transaction.
Show children Hide children
MobileCountryCodeinteger
Minimum: 3Maximum: 3
Identifies the country of a mobile phone operator. If data available.
MobileNetworkCodeinteger
Minimum: 2Maximum: 3
Identifies the mobile phone operator inside a country. If data available.
MaskedMSISDNinteger
Masked Mobile Subscriber Integrated Service Digital Network. If data available.
Geolocationobject
Geographic location specified by geographic or UTM coordinates. If data available.
Show children Hide children
GeographicCoordinatesobject
Show children Hide children
Latitudestring
Angular distance of a location on the earth south or north of the equator.
Longitudestring
Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.
UTMCoordinatesobject
Show children Hide children
UTMZonestring
UTM grid zone combination of the longitude zone (1 to 60) and the latitude band (C to X, excluding I and O).
UTMEastwardstring
X-coordinate of the Universal Transverse Mercator coordinate system.
UTMNorthwardstring
Y-coordinate of the Universal Transverse Mercator coordinate system.
ProtectedMobileDatastring
Sensitive information related to the mobile phone, protected by CMS. SensitiveMobileData.
SensitiveMobileDataobject
Sensitive information related to the mobile phone. If unprotected mobile data.
Show children Hide children
MSISDNinteger
Mobile Subscriber Integrated Service Digital Network (i.e. mobile phone number of the SIM card). Country, National Destination Code, and Subscriber Number.
IMSIinteger
International Mobile Subscriber Identity. Unique number associated with the mobile phone user, containing the Mobile Country Code (MCC), the Mobile Network Code (MNC), and the Mobile Identification Number (MSIN)
IMEIinteger
International Mobile Equipment Identity. Unique number associated with the mobile phone device.
StoredValueAccountIDobject
Identification of the stored value account or the stored value card and the associated product sold by the Sale System for stored value requests.
Show children Hide children
StoredValueAccountTypestring
Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account. Possible values:

GiftCard

Other

PhoneCard

StoredValueProviderstring
Identification of the provider of the stored value account load/reload. When the ProductCode is not sufficient to identify the provider host which delivers the load or reload of the stored value account (for example if it contains the identification of the application.)
OwnerNamestring
Name of the owner of a stored value account.
ExpiryDateinteger
Minimum: 4Maximum: 4
Date after which the card cannot be used. If EMV expiry date is present, it overrides Track2 information. Format is MMYY.
EntryModearray[string]
Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device). Possible values:

Contactless

File

ICC

Keyed

MagStripe

Manual

Mobile

RFID

Scanned

SynchronousICC

Tapped

IdentificationTypestring
Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

AccountNumber

BarCode

ISOTrack2

PAN

PhoneNumber

StoredValueIDstring
Stored value account identification. The identification of the stored value account conforming to the IdentificationType.
LoyaltyAccountarray[object]
Data related to the loyalty System.
Show children Hide children
LoyaltyAccountIDobject
Identification of a Loyalty account. In the Payment or the Loyalty Request message, it allows to identify the loyalty account by the Sale Terminal instead of the POI Terminal (e.g. because the account identification is a bar-code read by the Cashier on a scanner device).
Show children Hide children
EntryModearray[string]
Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. Possible values:

Contactless

File

ICC

Keyed

MagStripe

Manual

Mobile

RFID

Scanned

SynchronousICC

Tapped

IdentificationTypestring
Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. Possible values:

AccountNumber

BarCode

ISOTrack2

PAN

PhoneNumber

IdentificationSupportstring
Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification. Possible values:

HybridCard

LinkedCard

LoyaltyCard

NoCard

LoyaltyIDstring
Loyalty account identification conforming to the IdentificationType.
LoyaltyBrandstring
Identification of a Loyalty brand. If a card is analysed.

CardAcquisition Request

Request Parameters

Response parameters

HTTP Responses

200