Skip to content
/Customers

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

Customers

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

Operations

List customers

Request

Get a paginated list of all customers you saved in your system

Security
ApiKeyAuth
Query
limitinteger[ 1 .. 100 ]

The maximum number of customers to return

Default 10
offsetinteger>= 0

The number of customers to skip

Default 0
curl -i -X GET \
  'https://docs.helix-pay.net/_mock/apis/external.gen/customers?limit=10&offset=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
dataArray of objects(CustomerSchema)
metadataobject
Response
application/json
{
  "data": [
    { … }
  ],
  "metadata": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

Create a new customer

Request

Creates a new customer

Security
ApiKeyAuth
Bodyapplication/jsonrequired
first_namestring
last_namestring
emailstring
addressobject
curl -i -X POST \
  https://docs.helix-pay.net/_mock/apis/external.gen/customers \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "address": {
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 101",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94107",
      "country": "US"
    }
  }'

Responses

Customer created

Bodyapplication/json
idstring
Example: "cust_1ks881js771j"
first_namestring
last_namestring
emailstring
addressobject
Response
application/json
{
  "id": "cust_1ks881js771j",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "address": {
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 101",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94107",
    "country": "US"
  }
}

Get customer details

Request

Get details for a specific customer

Security
ApiKeyAuth
Path
customer_idstringrequired

The unique identifier for the customer

Example: cust_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9
curl -i -X GET \
  https://docs.helix-pay.net/_mock/apis/external.gen/customers/cust_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
idstring
Example: "cust_1ks881js771j"
first_namestring
last_namestring
emailstring
addressobject
Response
application/json
{
  "id": "cust_1ks881js771j",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "address": {
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 101",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94107",
    "country": "US"
  }
}

Update customer details

Request

Update details for a specific customer

Security
ApiKeyAuth
Path
customer_idstringrequired

The unique identifier for the customer

Example: cust_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9
Bodyapplication/jsonrequired
first_namestring
last_namestring
emailstring
addressobject
curl -i -X PATCH \
  https://docs.helix-pay.net/_mock/apis/external.gen/customers/cust_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9 \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "address": {
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 101",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94107",
      "country": "US"
    }
  }'

Responses

Successful response

Bodyapplication/json
idstring
Example: "cust_1ks881js771j"
first_namestring
last_namestring
emailstring
addressobject
Response
application/json
{
  "id": "cust_1ks881js771j",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "address": {
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 101",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94107",
    "country": "US"
  }
}

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.