Skip to content
API Reference/
/
Request a new payout

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

Request a new payout

Request

Creates a new withdrawal request for a consumer

Security
ApiKeyAuth
Bodyapplication/jsonrequired
consumer_idstring

The unique identifier for the consumer

amountnumber

The amount of the payout

currencystring

The currency of the payout

wallet_idstring

The unique identifier for the wallet to payout from

bank_account_idstring

The unique identifier for the bank account

curl -i -X POST \
  https://docs.helix-pay.net/_mock/apis/external.gen/payouts \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "consumer_id": "string",
    "amount": 0,
    "currency": "string",
    "wallet_id": "string",
    "bank_account_id": "string"
  }'

Responses

Payout created

Bodyapplication/json
idstring

The unique identifier for the payout

consumer_idstring

The unique identifier for the consumer

amountnumber

The amount of the payout

statusstring

The status of the payout

wallet_idstring

The unique identifier for the wallet to payout from

merchant_namestring

The name of the merchant

bank_account_idstring

The unique identifier for the bank account

created_atstring(date-time)

The timestamp when the payout was created

updated_atstring(date-time)

The timestamp when the payout was last updated

Response
application/json
{
  "id": "string",
  "consumer_id": "string",
  "amount": 0,
  "status": "string",
  "wallet_id": "string",
  "merchant_name": "string",
  "bank_account_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get payout details

Request

Security
ApiKeyAuth
Path
payout_idstringrequired
curl -i -X GET \
  'https://docs.helix-pay.net/_mock/apis/external.gen/payouts/{payout_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier for the payout

consumer_idstring

The unique identifier for the consumer

amountnumber

The amount of the payout

statusstring

The status of the payout

wallet_idstring

The unique identifier for the wallet to payout from

merchant_namestring

The name of the merchant

bank_account_idstring

The unique identifier for the bank account

created_atstring(date-time)

The timestamp when the payout was created

updated_atstring(date-time)

The timestamp when the payout was last updated

Response
application/json
{
  "id": "string",
  "consumer_id": "string",
  "amount": 0,
  "status": "string",
  "wallet_id": "string",
  "merchant_name": "string",
  "bank_account_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Cancel a payout request

Request

Security
ApiKeyAuth
Path
payout_idstringrequired
curl -i -X PATCH \
  'https://docs.helix-pay.net/_mock/apis/external.gen/payouts/{payout_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Payout updated

Bodyapplication/json
idstring

The unique identifier for the payout

consumer_idstring

The unique identifier for the consumer

amountnumber

The amount of the payout

statusstring

The status of the payout

wallet_idstring

The unique identifier for the wallet to payout from

merchant_namestring

The name of the merchant

bank_account_idstring

The unique identifier for the bank account

created_atstring(date-time)

The timestamp when the payout was created

updated_atstring(date-time)

The timestamp when the payout was last updated

Response
application/json
{
  "id": "string",
  "consumer_id": "string",
  "amount": 0,
  "status": "string",
  "wallet_id": "string",
  "merchant_name": "string",
  "bank_account_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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.