HiPay Balance API

Manage the balance of a HiPay account

Operations 1

GET /user-account/balance.{_format} Get the balance of a HiPay account #

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-balance-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-balance-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '0.3'
  title: HiPay Marketplace Balance 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: Balance
  description: Manage the balance of a HiPay account
paths:
  /user-account/balance.{_format}:
    get:
      description: '### Information

        Get the balance of a specific HiPay account.'
      operationId: get_user-account_balance
      parameters:
      - in: path
        name: _format
        required: true
        schema:
          type: string
          enum:
          - json
          - xml
          default: json
      - description: Date for the balance.
        in: query
        name: date
        schema:
          type: string
          format: date
          default: '2018-02-01'
      - 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:
        '200':
          description: Success response.
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Status code of the answer.
                    format: int32
                    type: integer
                  date:
                    description: Date for the balance (yyyy-mm-dd).
                    format: date-time
                    type: string
                  message:
                    description: Description of the answer.
                    type: string
                  balances:
                    description: List of account and sub-account balances.
                    type: array
                    items:
                      type: object
                      description: List of account and sub-account balances.
                      properties:
                        user_account_id:
                          description: Account ID.
                          format: int32
                          type: integer
                        user_account_type:
                          description: "### Account type\n\n   - `1`: Main account\n   - `2`: secondary account\n   - `3`: original account"
                          type: string
                        balance:
                          description: Account balance.
                          type: string
                        currency:
                          description: Account currency.
                          type: string
                        money_available_for_withdrawal:
                          description: Amount available for withdrawal.
                          type: string
        '400':
          description: Validation failed.
        '401':
          description: Authentication failed.
      summary: Get the balance of a HiPay account
      tags:
      - Balance
      security:
      - basicAuth: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic