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-sessions-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:
  contact:
    email: pi-ecommerce@hipay.com
  description: 'The Apple Pay API allows you to request a valid session from the Apple Pay server.


    Please note: this documentation describes the Apple Pay API parameters and response fields and allows you to test the platform in real time.


    ## Gateway API base URLs

    | Environment | Base URL |

    | --- | --- |

    | Stage | [https://stage-api.hipay.com/](https://stage-api.hipay.com/) |

    | Production | [https://api.hipay.com/](https://api.hipay.com/) |


    ## Authentication

    All requests to the HiPay Hpayment API require identification through *HTTP Basic Authentication*. Your API credentials can be found in the Integration section of your HiPay Enterprise back office. Most 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.


    `Authorization: Basic base64(''API login>:<API password>'')`'
  title: Apple PAY Sessions API
  version: 1.0.0
servers:
- url: https://stage-api.hipay.com
tags:
- name: Sessions
paths:
  /v1/applepay/paymentSession:
    post:
      responses:
        '202':
          description: Accepted - The request has succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplePayWeb_Response'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplePayWeb_Error'
        '401':
          description: Unauthorized - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplePayWeb_Error'
      operationId: createPaymentSession
      tags:
      - Sessions
      summary: Returns an opaque Apple Pay session object.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplePayWeb_Request'
        description: Request object
        required: true
components:
  schemas:
    ApplePayWeb_Request:
      required:
      - initiativeContext
      - validationUrl
      properties:
        displayName:
          description: A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Do not localize the name. Use only characters from the supported character sets in the fonts listed in Table 1.
          type: string
          maxLength: 64
          example: Hipay Shop
          format: words
        initiativeContext:
          description: A value you provide based on the initiative.
          type: string
          example: hipayshop.com
          format: hostname
        validationUrl:
          description: validation URLs provided by Apple
          type: string
          format: uri
          enum:
          - https://apple-pay-gateway.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod1.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod2.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod3.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod4.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod5.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod1.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod2.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod3.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod4.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod5.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod1-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod2-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod3-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod4-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-nc-pod5-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod1-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod2-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod3-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod4-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-pr-pod5-dr.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-sh-pod1.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-sh-pod1-dr.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-sh-pod2.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-sh-pod2-dr.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-sh-pod3.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-sh-pod3-dr.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-tj-pod1.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-tj-pod1-dr.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-tj-pod2.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-tj-pod2-dr.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-tj-pod3.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-tj-pod3-dr.apple.com/paymentservices/startSession
          - https://apple-pay-gateway-cert.apple.com/paymentservices/startSession
          - https://cn-apple-pay-gateway-cert.apple.com/paymentservices/startSession
    ApplePayWeb_Response:
      type: object
      description: Apple Pay session object.
      properties:
        epochTimestamp:
          type: string
        expiresAt:
          type: string
        merchantSessionIdentifier:
          type: string
        nonce:
          type: string
        merchantIdentifier:
          type: string
        domainName:
          type: string
        displayName:
          type: string
        signature:
          type: string
    ApplePayWeb_Error:
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: string
            code:
              type: string
            message:
              type: string
            description:
              type: string
            details:
              type: object
              properties:
                path:
                  type: string