find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hipay-connector-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: "## Description\nThe HiPay POS API allows you to trigger in-store payments by:\n- waking a point-of-sale (POS) payment terminal with the payment information (amount, currency, etc.)\n- creating the related transaction in HiPay Console, your dedicated management interface.\n\n*Please note: this documentation describes the POS API parameters and response fields and allows you to test the platform in real time.  \nIf you are looking for information about its integration, please check the [dedicated documentation](/point-of-sale/smart-terminal/pos-api).*\n## Prerequisites\n- Internet connection:\n  - a working and stable Wi-Fi connection is needed to join the payment terminal\n  - a fixed public IP address for the network router is needed to join the payment terminal. In case your public IP address changes over time, it is usually possible to fix it by contacting your Internet access provider (please notice additional costs may be applied).\n## Base URLs\n| Environment | Base URL |\n| --- | --- |\n| Stage | [https://cloudrun-api-yugcnet4yq-ew.a.run.app/](https://cloudrun-api-yugcnet4yq-ew.a.run.app/) |\n| Production | [https://cloudrun-api-n3l7nqotca-ew.a.run.app/](https://cloudrun-api-n3l7nqotca-ew.a.run.app/) |\n## Authentication\nThe HiPay POS API relies on *HTTP Basic Authentication*: for every request, API credentials must be provided in the request headers.\n\nMost HTTP clients (including web browsers) have built-in support for HTTP basic authentication. If not, the following header must be included in all HTTP requests.\n`Authorization: Basic base64('<API login>:<API password>')`\n\n*Note #1: API credentials can be found in the Integration section of your HiPay Enterprise back office.*  \n*Note #2: Only **private credentials** can be used to authenticate (\"Accessibility\" value = \"Private\").*\n## Security\nFor security reasons, it is highly recommended to filter access to your electronic POS payment terminals, based on the request origins.\nTo make sure only requests coming from HiPay will be able to join your terminals, you can set up an IP packet filtering rule on your firewall based on the following IPs:\n| Environment | IP |\n| --- | --- |\n| Stage | 35.241.177.31 |\n| Production | 35.205.91.234 |\n"
  title: POS Connector API
  version: 1.2.0
servers:
- url: https://cloudrun-api-yugcnet4yq-ew.a.run.app/
  description: Stage
tags:
- name: Connector
paths:
  /v1/connector/healthcheck:
    get:
      description: Health check
      responses:
        '200':
          description: Health check OK
      operationId: healthcheck
      tags:
      - Connector
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic