Skip to content
/Banks

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

Create a new bank account

Request

Creates a new bank account

Security
ApiKeyAuth
Path
consumer_idstringrequired

The unique identifier for the consumer

Example: csm_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9
Bodyapplication/jsonrequired
bank_namestring

The name of the bank

Example: "Bank of Dave"
namestring

Nice name of bank for user

Example: "My Primary Account"
mandate_typestringrequired

The type of mandate for the bank account

Example: "IBAN"
dataobjectrequired

The bank account data

curl -i -X POST \
  https://docs.helix-pay.net/_mock/apis/external.gen/consumers/csm_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9/banks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "bank_name": "Bank of Dave",
    "name": "My Primary Account",
    "mandate_type": "IBAN",
    "data": {}
  }'

Responses

Bank created

Bodyapplication/json
idstring

The unique identifier for the bank account

Example: "ba_589b9558211e0182"
consumer_idstring

The unique identifier for the consumer

bank_namestring

The name of the bank

mandate_typestring

The type of mandate for the bank account

Example: "IBAN"
dataobject

The bank account data

Example: "{ \"iban\": \"GB33BUKB20201555555555\", \"bic\": \"BUKBGB22\" }"
Response
application/json
{
  "id": "ba_589b9558211e0182",
  "consumer_id": "string",
  "bank_name": "string",
  "mandate_type": "IBAN",
  "data": "{ \"iban\": \"GB33BUKB20201555555555\", \"bic\": \"BUKBGB22\" }"
}

Get bank account details

Request

Get details for a specific bank account

Security
ApiKeyAuth
Path
consumer_idstringrequired

The unique identifier for the consumer

Example: csm_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9
bank_idstringrequired

The unique identifier for the bank account

Example: ba_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/banks/ba_3bbb4fe7-4c25-45b2-a363-c8db8c0084b9 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier for the bank account

Example: "ba_589b9558211e0182"
consumer_idstring

The unique identifier for the consumer

bank_namestring

The name of the bank

mandate_typestring

The type of mandate for the bank account

Example: "IBAN"
dataobject

The bank account data

Example: "{ \"iban\": \"GB33BUKB20201555555555\", \"bic\": \"BUKBGB22\" }"
Response
application/json
{
  "id": "ba_589b9558211e0182",
  "consumer_id": "string",
  "bank_name": "string",
  "mandate_type": "IBAN",
  "data": "{ \"iban\": \"GB33BUKB20201555555555\", \"bic\": \"BUKBGB22\" }"
}

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.