This service can be used by the POS Partner (Merchant) to initiate a Card verification of a card via a Payment Terminal or via an online channel.
COMPATIBILITY
| Type | Compatibility |
|---|---|
| Card present (CP) | Yes |
| Card not present (CNP) | Yes |
REQUEST
| Type | Endpoint |
|---|---|
| POST | /payment/v1/interface/pos/initPreAuth |
PARAMETERS
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
ServerName |
string |
Name of the calling server |
Y |
Y |
S-RF-H9732-FS1 |
|
WorkStationName |
String |
Name of the calling station The workstation must be linked to the payment terminal to awake it in case of card present message. |
Y |
Y |
L-5G01TH4 |
|
MerchantCode |
String |
Name of the calling origin (Merchant code) |
Y |
Y |
0449 |
| PartnerCode | String |
Name of the calling partner (Partner code) This code will allow to retreive transactions in the payment provider extranet |
Y | Y | Fols |
| PosCode | String | Name of calling point of sale (Hotel, Restaurant, Bar, Spa…) | Y | Y | H |
|
Token |
string |
Card token which allow Accor to know if client is present or not. |
N |
Y |
8766778345690119 |
|
ExpirationDate |
string |
Card expiration date Format="YYMM" |
N |
Y |
2206 |
|
Amount |
String |
Transaction amount the value must be less than or equal to 1.00euro (otherwise it will be considered as a preauthorization) |
Y |
Y |
1.00 |
|
Currency |
String (200) |
Transaction currency |
Y |
Y |
EUR |
|
Device |
Integer |
Type of device |
Y |
Y |
CNP : 0 CP : 1 |
| TransactionId | String (50) |
Transaction reference regarding the previous payment transaction. Should be present but null in this use case |
Y | Y |
RESPONSE
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
responseCode |
String |
- 0 : if response OK - 99 : if response KO for CNP message - 10 : if response OK for CP message
Note: for CP, a polling message will follow to validate definitely the transaction. |
Y |
Y |
99 |
|
responseMessage |
String |
- 0 : OPERATION_OK - 99 : DeviceOut - 10 : OPERATION_IN_PROGRESS
Note: this response message can contain the description of the error. |
Y |
Y |
99 |
|
responseIdentifier |
String |
Response identifier generated by Accor |
Y |
N |
H9732FO20101962596VRF |
|
responseObject |
String |
response object (see details below) |
N |
Y |
|
|
nextPollingTime |
String |
Timer reference for the next transaction in case of CP Time in second |
Y |
N |
20 |
Detail of the object "responseObject"
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
Token |
string |
Card token which allow Accor to know if client is present or not. |
Y |
Y |
8766778345690119 |
|
ExpirationDate |
string |
Card expiration date Format: “YYMM” |
Y |
Y |
2206
|
|
Amount |
String |
Transaction amount |
Y |
Y |
1.00 |
|
Currency |
String (200) |
Transaction currency Format “XXX” |
Y |
Y |
EUR |
|
CardType |
String (200) |
Card type : VI, CA, AX Other card : JC, DC, CU, PF, BC, RU a mapping could be done depending partner |
Y |
Y |
VI |
|
ClientTicket |
String (1000) |
Customer receipt if payment is OK |
Y |
Y |
|
|
MerchantTicket |
String (1000) |
Merchant receipt if payment is OK |
Y |
Y |
|
|
ApprovalCode |
String (8) |
Acquirer approval code for the transaction |
Y |
Y |
041016 |
|
TransactionId |
String (50) |
Identifier reference for the transaction |
Y |
Y |
84547193121
|
|
ResponseCode |
String |
- 0 : if response OK - 99 : if response KO for CNP message - 10 : if response KO for CP message
Note: for CP, a polling message will follow to validate definitely the transaction. |
Y |
Y |
99 |
|
ResponseMessage |
String |
- 0 : OPERATION_OK - 99 : DeviceOut - 10 : OPERATION_IN_PROGRESS
Note: this response message can contain the description of the error. |
Y |
Y |
99 |
POLLING MESSAGE
This service can be used by the POS Partner (Merchant) to check a card. (only for CP model)
Request
| Type | Endpoint |
|---|---|
| GET | /payment/v1/interface/pos/transactions/{transactionId} |
Response
| Name | Description |
|---|---|
| status |
OK : the transaction has been correctly processed. KO : the transaction has not been correctly processed. In progress : the transaction has not a definitive status yet. |
EXAMPLE 1
This example show request/response for a card present transaction.
Example of request :
|
{ "Token":"", "ExpirationDate":"", "Amount":"1.00", "Currency":"EUR", "Device":"1", "TransactionId": "", "ServerName":"S-RF-H9732-F1", "WorkStationName":"L-5C046FG", "MerchantCode":"9732", "PartnerCode":"FOLS", "PosCode":"H" } |
Example of response :
|
{ "responseCode": "10", "responseMessage": "OPERATION_IN_PROGRESS", "responseIdentifier": "H9732FO20101962596VRF", "responseObject": "null", "nextPollingTime": "20" } |
Example of response after polling message :
3 possibilities:
- same response as response OK for Card not present.
- same response as response KO for Card not present.
- Same response as in progress response but with different nextPollingTime value.
EXAMPLE 2
This example show request/response for a card not present transaction.
Example of request :
|
{ "Token":"8766778345690119", "ExpirationDate":"2212", "Amount":"1.00", "Currency":"EUR", "Device":"0", "TransactionId" : "", "ServerName":"S-RF-H9732-F1", "WorkStationName":"L-5C046FG", "MerchantCode":"9732", "PartnerCode":"FOLS", "PosCode":"H" } |
Example of response OK :
|
{ "responseCode": "0", "responseMessage": "OPERATION_OK", "responseIdentifier": "null", "responseObject": { "responseCode": "0", "responseMessage": "OPERATION_OK", "currency": "EUR", "cardType": "5", "clientTicket": "APOL MERCURE VALENCIENNES CENTRE Musterstr. 01 Musterstadt 90111 GERMANY -------------------------------- 24.09.20 17:16 KUNDENBELEG -------------------------------- TERMINAL: 54055584 HANDLER: 147777778 PAN: XXXXXXXXXXXX0119 KARTENTYP: Visa MANUELLES STORNO MANUELLER EINTRAG BETRAG: 190,00 EUR REFERENZ: 770233171212 GENEHMIGUNGS-NR.: SM5845 (00) AUTORISIERUNG ERFOLGT KEINE KARTENINH. VERIFIZIERUNG BITTE FUR IHRE UNTERLAG. AUFBEW.", "merchantTicket": "APOL MERCURE VALENCIENNES CENTRE Musterstr. 01 Musterstadt 90111 GERMANY -------------------------------- 24.09.20 17:16 HANDLERBELEG -------------------------------- TERMINAL: 54055584 HANDLER: 147777778 PAN: XXXXXXXXXXXX0119 KARTENTYP: Visa MANUELLES STORNO MANUELLER EINTRAG BETRAG: 190,00 EUR\ REFERENZ: 770233171212 GENEHMIGUNGS-NR.: SM5845 (00) AUTORISIERUNG ERFOLGT KEINE KARTENINH. VERIFIZIERUNG BITTE FUR IHRE UNTERLAG. AUFBEW.", "approvalCode": "041016", "token": "8766778345690119", "expirationDate": "2212", "amount": "1.00", "transactionId": "84547193121" }, "nextPollingTime": "null" } |
Example of response KO :
|
{ "responseCode": "99", "responseMessage": "Busy", "responseIdentifier": "null", "responseObject": "null", "nextPollingTime": "null" } |