Service endpoints

There are two endpoints (base URLs) to which you can make your API calls:

• Stage, if you are testing your integration,
• and Production, when you have finished testing and want your application to go live.

Request parameters

First, please read the documentation for omnichannel APIs on our Developer Portal.

Then, for further details, please refer to the technical documentation.

To generate a POS order, you must send the following parameters in your transaction creation call.

Payment settings

Customer information (not displayed on the POS terminal)

API response fields

{
 "state": "pending",
 "reason": "",
 "forwardUrl": "",
 "test": "true",
 "mid": "00001234567",
 "attemptId": "1",
 "authorizationCode": "",
 "transactionReference": "800000021115",
 "dateCreated": "2018-03-28T15:10:49+0000",
 "dateUpdated": "2018-03-28T17:10:50+0200",
 "dateAuthorized": "",
 "status": "174",
 "message": "Awaiting Terminal",
 "authorizedAmount": "0.00",
 "capturedAmount": "0.00",
 "refundedAmount": "0.00",
 "creditedAmount": "0.00",
 "decimals": "2",
 "currency": "EUR",
 "ipAddress": "0.0.0.0",
 "ipCountry": "",
 "deviceId": "",
 "cdata1": "",
 "cdata2": "",
 "cdata3": "",
 "cdata4": "",
 "cdata5": "",
 "cdata6": "",
 "cdata7": "",
 "cdata8": "",
 "cdata9": "",
 "cdata10": "",
 "avsResult": "",
 "cvcResult": "",
 "eci": "10",
 "paymentProduct": "",
 "paymentMethod": "",
 "threeDSecure": "",
 "fraudScreening": {
 "scoring": "0",
 "result": "NOT_LAUNCHED",
 "review": ""
 },
 "order": {
 "id": "HIPAYTEST_1522249708_3",
 "dateCreated": "2018-03-28T15:10:48+0000",
 "attempts": "1",
 "amount": "125.00",
 "shipping": "0.00",
 "tax": "0.00",
 "decimals": "2",
 "currency": "EUR",
 "customerId": "",
 "language": "fr_FR",
 "email": ""
 },
 "debitAgreement": {
 "id": "",
 "status": ""
 }
}