Skip to content
API Reference/
/
Create a new wallet

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

Create a new wallet

Request

Creates a new wallet

Security
ApiKeyAuth
Bodyapplication/jsonrequired
consumer_idstring

The unique identifier for the consumer

Example: "csm_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9"
currencystring

The currency of the wallet

Example: "EUR"
curl -i -X POST \
  https://docs.helix-pay.net/_mock/apis/external.gen/wallets \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "consumer_id": "csm_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9",
    "currency": "EUR"
  }'

Responses

Wallet created

Bodyapplication/json
idstring

The unique identifier for the wallet

Example: "wlt_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9"
consumer_idstring

The unique identifier for the consumer

currencystring

The currency of the wallet

Example: "EUR"
balancenumber

The current balance of the wallet

created_atstring(date-time)

The timestamp when the wallet was created

updated_atstring(date-time)

The timestamp when the wallet was last updated

Response
application/json
{
  "id": "wlt_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9",
  "consumer_id": "string",
  "currency": "EUR",
  "balance": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get wallet details

Request

Get details for a specific wallet

Security
ApiKeyAuth
Path
wallet_idstringrequired

The unique identifier for the wallet

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

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier for the wallet

Example: "wlt_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9"
consumer_idstring

The unique identifier for the consumer

currencystring

The currency of the wallet

Example: "EUR"
balancenumber

The current balance of the wallet

created_atstring(date-time)

The timestamp when the wallet was created

updated_atstring(date-time)

The timestamp when the wallet was last updated

Response
application/json
{
  "id": "wlt_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9",
  "consumer_id": "string",
  "currency": "EUR",
  "balance": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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.