Skip to content
API Reference/
/
Create a new consumer

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

Create a new consumer

Request

Creates a new consumer

Security
ApiKeyAuth
Bodyapplication/jsonrequired
consumer_typestringrequired

The type of consumer. Can be either INDIVIDUAL or BUSINESS.

Example: "INDIVIDUAL"
detailsobject(CreateConsumerPersonalDetailsSchema)required

If consumer_type is INDIVIDUAL, personal_details must be provided. If consumer_type is BUSINESS, company_details must be provided.

details.​first_namestring
details.​last_namestring
details.​emailstring(email)required
details.​phonestring
Example: "+44123456789"
curl -i -X POST \
  https://docs.helix-pay.net/_mock/apis/external.gen/consumers \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "consumer_type": "INDIVIDUAL",
    "details": {
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "phone": "+44123456789"
    }
  }'

Responses

Consumer created

Bodyapplication/json
idstringrequired
Example: "csm_1234abcd"
merchant_environment_idstringrequired
Example: "env_1234"
consumer_typestringrequired
Example: "INDIVIDUAL"
check_statusstring or null
Example: "PENDING"
check_reference_idstring or null
Example: "chk_1234abcd"
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "csm_1234abcd",
  "merchant_environment_id": "env_1234",
  "consumer_type": "INDIVIDUAL",
  "check_status": "PENDING",
  "check_reference_id": "chk_1234abcd",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get consumer details

Request

Get details for a specific consumer

Security
ApiKeyAuth
Path
consumer_idstringrequired

The unique identifier for the consumer

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

Responses

Successful response

Bodyapplication/json
idstringrequired
Example: "csm_1234abcd"
merchant_environment_idstringrequired
Example: "env_1234"
consumer_typestringrequired
Example: "INDIVIDUAL"
check_statusstring or null
Example: "PENDING"
check_reference_idstring or null
Example: "chk_1234abcd"
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "csm_1234abcd",
  "merchant_environment_id": "env_1234",
  "consumer_type": "INDIVIDUAL",
  "check_status": "PENDING",
  "check_reference_id": "chk_1234abcd",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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

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.