This service can be used by the POS Partner (Merchant) to Manage the Reconciliation via an online channel.
COMPATIBILITY
| Type | Compatibility |
|---|---|
| Card present (CP) | No |
| Card not present (CNP) | Yes |
REQUEST
| Type | Endpoint |
|---|---|
| POST | /payment/v1/interface/pos/getTotalAmount |
PARAMETERS
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
ServerName |
string |
Name of the calling server |
|
Y |
S-RF-H9732-FS1 |
|
WorkStationName |
String |
Name of the calling station |
|
Y |
L-5G01TH4 |
|
MerchantCode |
String |
Name of the calling origin (Merchant code) |
|
Y |
0449 |
| PartnerCode | String |
Name of the calling partner This code will allow to retreive transactions in the payment provider extranet |
Y | Fols | |
| PosCode | String | Name of the calling point of sale (Hotel, Restaurant, Bar, Spa…) | Y | H | |
| CardType | Integer |
Card type : VI, CA, AX Other card : JC, DC, CU, PF, BC, RU |
Y | VI | |
| Currency | String (200) | Transaction currency | Y | EUR |
RESPONSE
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
responseCode |
String |
Response code depending on transaction status: - 0 : if response OK - 99 : if response KO for CNP message |
|
Y |
99 |
|
responseMessage |
String |
- 0 : OPERATION_OK - 99 : DeviceOut
Note: this response message can contain the description of the error. |
|
Y |
DeviceOut |
|
responseIdentifier |
String |
Should be "null" |
|
N |
Null |
|
responseObject |
String |
response object (see details below) |
|
Y |
|
|
nextPollingTime |
String |
Should be "null" |
|
N |
Null |
Detail of the object "responseObject"
|
Name |
Type |
Description |
CP mandatory |
CNP mandatory |
Example |
|
TotalAmount |
String |
Transaction amount |
|
Y |
0.00 |
|
Currency |
String (200) |
Transaction currency |
|
Y |
EUR Format “XXX” |
|
CardType |
String (200) |
Card type : VI, CA, AX Other card : JC, DC, CU, PF, BC, RU a mapping could be done depending partner |
|
Y |
VI |
|
ResponseCode |
String |
- 0 : if response OK - 99 : if response KO for CNP message |
|
Y |
99 |
|
ResponseMessage |
String |
- 0 : OPERATION_OK - 99 : DeviceOut
Note: this response message can contain the description of the error. |
|
Y |
99 |
| PartnerCode | String |
Name of the calling partner |
Y | Fols |
EXAMPLE 1
This example show request/response for a card not present transaction.
Example of request :
|
{ "CardType":"VI", "Currency":"EUR", "ServerName":"S-RF-H9732-FLS1", "WorkStationName":"L-5CG9046FLG", "MerchantCode":"9732", "PartnerCode":"FOLS", "PosCode":"H" } |
Example of response OK :
|
{ "responseCode": "0", "responseMessage": "OPERATION_OK", "responseIdentifier" : "null", "responseObject" : { "responseCode": "0", "responseMessage": "OPERATION_OK", "CardType": "VI", "Currency": "EUR", "TotalAmount": "0.00" }, "nextPollingTime" : "null" } |
Example of response KO :
|
{ "responseCode": "99", "responseMessage": "NotFound", "responseIdentifier": "null", "responseObject": "null", "nextPollingTime": "null" } |