Skip to content
/Integrations

Helix-Pay API (1.0.0)

API documentation for the Helix-Pay API

Download OpenAPI description
external.gen.json
external.gen.yaml
Languages
Servers
Mock server
https://docs.helix-pay.net/_mock/apis/external.gen/
Production server
https://api.helix-pay.net/v1/

Payments

Operations related to payments

Operations

Consumers

Operations related to consumers. Consumers are mostly used in marketplace-type applications where they can deposit money in their account to pay for other goods or services or payout to their bank accounts.

Operations

Wallets

Operations related to wallets. Wallets are used to store funds for consumers.

Operations

Banks

Operations related to bank accounts. Bank accounts are used to withdraw funds from wallets.

Operations

Payouts

Operations related to payouts. Payouts are used to withdraw funds from wallets to bank accounts.

Operations

Integrations

Operations related to integrations. Integrations are used to connect Helix Pay with external systems (e.g. WIX).

Operations

Create a new integration

Request

Creates a new integration with an external system (e.g. Wix)

Security
ApiKeyAuth
Bodyapplication/jsonrequired
labelstring

The label for the integration

integration_codestringrequired

The code for the integration

configWixIntegrationConfig (object)required
WixIntegrationConfig (object)
curl -i -X POST \
  https://docs.helix-pay.net/_mock/apis/external.gen/integrations \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "label": "string",
    "integration_code": "string",
    "config": {
      "update_url": "https://WIX_USER.wixsite.com/WIX_SHOP/_functions/updateTransaction/"
    }
  }'

Responses

Integration created

Bodyapplication/json
idstring

The unique identifier for the integration

namestring

The name of the integration

typestring

The type of the integration

dataobject

The integration data

Response
application/json
{
  "id": "string",
  "name": "string",
  "type": "string",
  "data": {}
}

Get integration details

Request

Get details for a specific integration

Security
ApiKeyAuth
Path
integration_idstringrequired
Example: int_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9
curl -i -X GET \
  https://docs.helix-pay.net/_mock/apis/external.gen/integrations/int_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier for the integration

namestring

The name of the integration

typestring

The type of the integration

dataobject

The integration data

Response
application/json
{
  "id": "string",
  "name": "string",
  "type": "string",
  "data": {}
}

Customers

Operations related to customers. Customers are the end-users who make payments. Not to be confused with consumers.

Operations

Balances

Operations related to account balances.

Operations

Sub-Merchants

Operations related to sub-merchants management. Allows parent merchants to manage their sub-merchants and create payments on their behalf, while also viewing volume analytics and current balances.

Operations

Health check endpoint

Request

A simple endpoint to check the health of the API

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.helix-pay.net/_mock/apis/external.gen/health \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
messagestringrequired
Response
application/json
{
  "message": "string"
}
Copyright © Helix-Pay LTD. No rights reserved.