HiPay Merchant Group API

Manage merchant groups

Operations 2

GET /merchant-group/{merchant_group_code}.{_format} List merchant group member #
GET /merchant-group/{merchant_group_code}/count.{_format} Count merchant group member #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-merchant-group-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.

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

OpenAPI Specification

hipay-merchant-group-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '0.3'
  title: HiPay Marketplace Merchant Group API
  description: The implementation of HiPay Marketplace involves establishing connections between your marketplace platform and HiPay based on a simple integration through a set of APIs.
servers:
- url: https://test-professional.hipay.com/api
tags:
- name: merchant-group
  description: Manage merchant groups
paths:
  /merchant-group/{merchant_group_code}.{_format}:
    get:
      summary: List merchant group member
      description: '### Information


        List merchant group member.'
      parameters:
      - in: path
        name: merchant_group_code
        required: true
        schema:
          type: string
          default: devportaltest
      - in: path
        name: _format
        required: true
        schema:
          type: string
          enum:
          - json
          - xml
          default: json
      - in: query
        description: The date from which the member accounts were created
        name: past_date
        schema:
          type: string
          format: date
          default: '2018-01-01'
      - in: query
        description: Account type
        name: account_type[]
        schema:
          type: string
          enum:
          - merchant
          - associator
          - admin
          default: merchant
      - in: query
        description: Number of results to display on each page. Default is 20
        name: nb_result_per_page
        schema:
          type: integer
          format: int32
          default: 20
      - in: query
        description: Page number. First page has number 1. Default is 1
        name: page
        schema:
          type: integer
          format: int32
          default: 1
      - description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
        in: header
        name: php-auth-subaccount-id
        schema:
          type: integer
      - description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
        in: header
        name: php-auth-subaccount-login
        schema:
          type: string
      responses:
        '201':
          description: Success response.
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                    format: int32
                    description: Status code of the answer.
                  message:
                    type: string
                    description: Description of the answer.
                  merchant_group_name:
                    type: string
                    description: Merchant group name
                  account_type:
                    type: array
                    items:
                      type: string
                    description: List of account type
                  total_merchant:
                    type: integer
                    format: int32
                    description: Total merchant
                  past_date:
                    type: string
                    description: The date from which the member accounts were created
                  nb_result_per_page:
                    type: integer
                    format: int32
                    description: Number of result per page
                  page:
                    type: integer
                    format: int32
                    description: Page number
                  merchants_list:
                    type: array
                    items:
                      type: string
                    description: List of members
        '400':
          description: Validation failed.
        '401':
          description: Authentication failed.
      tags:
      - merchant-group
      security:
      - basicAuth: []
      operationId: getMerchantGroupByMerchantGroupCode}{Format
      x-operation-id-source: derived
  /merchant-group/{merchant_group_code}/count.{_format}:
    get:
      summary: Count merchant group member
      description: '### Information


        Count merchant group member.'
      parameters:
      - in: path
        name: merchant_group_code
        required: true
        schema:
          type: string
          default: devportaltest
      - in: path
        name: _format
        required: true
        schema:
          type: string
          enum:
          - json
          - xml
          default: json
      - in: query
        description: The date from which the member accounts were created
        name: past_date
        schema:
          type: string
          format: date
          default: '2018-01-01'
      - in: query
        description: Account type
        name: account_type[]
        schema:
          type: string
          enum:
          - merchant
          - associator
          - admin
          default: merchant
      - description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
        in: header
        name: php-auth-subaccount-id
        schema:
          type: integer
      - description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
        in: header
        name: php-auth-subaccount-login
        schema:
          type: string
      responses:
        '201':
          description: Success response.
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                    format: int32
                    description: Status code of the answer.
                  message:
                    type: string
                    description: Description of the answer.
                  merchant_group_name:
                    type: string
                    description: Merchant group name
                  account_type:
                    type: array
                    items:
                      type: string
                    description: List of account type
                  total_merchant:
                    type: integer
                    format: int32
                    description: Total merchant
                  past_date:
                    type: string
                    description: The date from which the member accounts were created
        '400':
          description: Validation failed.
        '401':
          description: Authentication failed.
      tags:
      - merchant-group
      security:
      - basicAuth: []
      operationId: getMerchantGroupByMerchantGroupCodeCount{Format}
      x-operation-id-source: derived
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic