POS API Integration

The HiPay POS API allows you to process in store payments and create a transaction on HiPay Console.

The payment workflow is the following one:

      1. Your POS Software calls the POS API

      2. HiPay Platform uses the POS Device to display the amount

      3. Once the client has completed the payment, the HiPay platform contacts the acquirer to process the payment

      4. Once the payment has been processed, the payment result is displayed on the POS Device, and sent to your POS Software.

      5. If the payment is successful, a transaction will be created on HiPay Console.

      6. A day later, the HiPay Platform will receive the financial information of the acquirer, and update the transactions.

 

Requirements

Terminal Compatibility

 

Network

 

HiPay Account

You need to have an active HiPay account in order to be able to call this API.

Payment

Please find the API description 

Sandbox mode

In order to mock the payment response and do all your testing, you can add, in stage environment only, the field “sandbox_code” that will render any response as you expected.  

Case 

Sandbox code

HTTP Code

Response

Payment OK

“00”

201

{ “paymentStatus”: “Success”, “order”: { }, “customer”: { }, “shipping”: { }, “technical_pos_info”: { }}

Payment failed

“10”

200

{ “paymentStatus”: “Failed”, “errorCode”: “10”, “errorDescription”: “Operation not performed”, “order”: { }, “customer”: { }, “shipping”: { }, “technical_pos_info”: { }}

Unable to contact the terminal

“20”

400

{ “error”: { “status”: 400, “code”: unavailable.terminal.bad.request, “message”: “Bad Request”, “description”: “Unable to contact the terminal. Host : \”XXX.XXX.XXX.XXX\”, Port: \”XXXX\””, “details”: {} } }

Internal Error

“50”

500

{ “error”: { “status”: 500, “code”: “undefined.internal.server.error”, “message”: “Server Error”, “description”: “Server Error”, “details”: {} } }