# Helix-Pay API

API documentation for the Helix-Pay API

Version: 1.0.0

## Servers

Production server
```
https://api.helix-pay.net/v1
```

## Security

### ApiKeyAuth

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Helix-Pay API](https://docs.helix-pay.net/_bundle/apis/external.gen.yaml)

## Payments

Operations related to payments

### List payments

 - [GET /payments](https://docs.helix-pay.net/apis/external.gen/payments/paths/~1payments/get.md): Get a paginated list of all payments made by consumers

### Create a new payment

 - [POST /payments](https://docs.helix-pay.net/apis/external.gen/payments/paths/~1payments/post.md): Creates a new payment request

### Get payment details

 - [GET /payments/{payment_id}](https://docs.helix-pay.net/apis/external.gen/payments/paths/~1payments~1%7Bpayment_id%7D/get.md): Get details for a specific payment

### Update payment status

 - [PATCH /payments/{payment_id}](https://docs.helix-pay.net/apis/external.gen/payments/paths/~1payments~1%7Bpayment_id%7D/patch.md): Update the details of a specific payment

### Refund a payment

 - [POST /payments/{payment_id}/refund](https://docs.helix-pay.net/apis/external.gen/payments/paths/~1payments~1%7Bpayment_id%7D~1refund/post.md): Request a refund for a specific payment

### Cancel a payment

 - [POST /payments/{payment_id}/cancel](https://docs.helix-pay.net/apis/external.gen/payments/paths/~1payments~1%7Bpayment_id%7D~1cancel/post.md): Cancel a specific payment. You can only cancel payments that are in the CREATED status.

## 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.

### Create a new consumer

 - [POST /consumers](https://docs.helix-pay.net/apis/external.gen/consumers/paths/~1consumers/post.md): Creates a new consumer

### Get consumer details

 - [GET /consumers/{consumer_id}](https://docs.helix-pay.net/apis/external.gen/consumers/paths/~1consumers~1%7Bconsumer_id%7D/get.md): Get details for a specific consumer

## Wallets

Operations related to wallets. Wallets are used to store funds for consumers.

### Create a new wallet

 - [POST /wallets](https://docs.helix-pay.net/apis/external.gen/wallets/paths/~1wallets/post.md): Creates a new wallet

### Get wallet details

 - [GET /wallets/{wallet_id}](https://docs.helix-pay.net/apis/external.gen/wallets/paths/~1wallets~1%7Bwallet_id%7D/get.md): Get details for a specific wallet

## Banks

Operations related to bank accounts. Bank accounts are used to withdraw funds from wallets.

### Create a new bank account

 - [POST /consumers/{consumer_id}/banks](https://docs.helix-pay.net/apis/external.gen/banks/paths/~1consumers~1%7Bconsumer_id%7D~1banks/post.md): Creates a new bank account

### Get bank account details

 - [GET /consumers/{consumer_id}/banks/{bank_id}](https://docs.helix-pay.net/apis/external.gen/banks/paths/~1consumers~1%7Bconsumer_id%7D~1banks~1%7Bbank_id%7D/get.md): Get details for a specific bank account

## Payouts

Operations related to payouts. Payouts are used to withdraw funds from wallets to bank accounts.

### Request a new payout

 - [POST /payouts](https://docs.helix-pay.net/apis/external.gen/payouts/paths/~1payouts/post.md): Creates a new withdrawal request for a consumer

### Get payout details

 - [GET /payouts/{payout_id}](https://docs.helix-pay.net/apis/external.gen/payouts/paths/~1payouts~1%7Bpayout_id%7D/get.md)

### Cancel a payout request

 - [PATCH /payouts/{payout_id}](https://docs.helix-pay.net/apis/external.gen/payouts/paths/~1payouts~1%7Bpayout_id%7D/patch.md)

## Integrations

Operations related to integrations. Integrations are used to connect Helix Pay with external systems (e.g. WIX).

### Create a new integration

 - [POST /integrations](https://docs.helix-pay.net/apis/external.gen/integrations/paths/~1integrations/post.md): Creates a new integration with an external system (e.g. Wix)

### Get integration details

 - [GET /integrations/{integration_id}](https://docs.helix-pay.net/apis/external.gen/integrations/paths/~1integrations~1%7Bintegration_id%7D/get.md): Get details for a specific integration

## Customers

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

### List customers

 - [GET /customers](https://docs.helix-pay.net/apis/external.gen/customers/paths/~1customers/get.md): Get a paginated list of all customers you saved in your system

### Create a new customer

 - [POST /customers](https://docs.helix-pay.net/apis/external.gen/customers/paths/~1customers/post.md): Creates a new customer

### Get customer details

 - [GET /customers/{customer_id}](https://docs.helix-pay.net/apis/external.gen/customers/paths/~1customers~1%7Bcustomer_id%7D/get.md): Get details for a specific customer

### Update customer details

 - [PATCH /customers/{customer_id}](https://docs.helix-pay.net/apis/external.gen/customers/paths/~1customers~1%7Bcustomer_id%7D/patch.md): Update details for a specific customer

## Balances

Operations related to account balances.

### Get balance

 - [GET /balance](https://docs.helix-pay.net/apis/external.gen/balances/paths/~1balance/get.md): Get the balance of the account identified by the API key in all enabled currencies

## 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.

### List sub-merchants

 - [GET /merchants](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants/get.md): Get a list of all sub-merchants associated with your parent merchant account.

### List signup sessions

 - [GET /merchants/signup-sessions](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1signup-sessions/get.md): Get all signup sessions created by your parent merchant

### Create signup session

 - [POST /merchants/signup-sessions](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1signup-sessions/post.md): Create a new signup session for a sub-merchant

### Get signup session

 - [GET /merchants/signup-sessions/{sessionId}](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1signup-sessions~1%7Bsessionid%7D/get.md): Retrieve details of a specific signup session

### Update signup session

 - [PATCH /merchants/signup-sessions/{sessionId}](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1signup-sessions~1%7Bsessionid%7D/patch.md): Update an existing signup session

### Delete signup session

 - [DELETE /merchants/signup-sessions/{sessionId}](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1signup-sessions~1%7Bsessionid%7D/delete.md): Delete a signup session. This only works if the session is in CREATED status. Already completed, in progress, or expired sessions cannot be deleted.

### Reactivate signup session

 - [POST /merchants/signup-sessions/{sessionId}/reactivate](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1signup-sessions~1%7Bsessionid%7D~1reactivate/post.md): Reactivate an expired or cancelled signup session. This extends an expired session by 3 days from the time of reactivation.

### Get sub-merchant balance

 - [GET /merchants/{merchantId}/balance](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1%7Bmerchantid%7D~1balance/get.md): Get the current balance for a specific sub-merchant

### Get sub-merchant payments

 - [GET /merchants/{merchantId}/payments](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1%7Bmerchantid%7D~1payments/get.md): Retrieve payments for a specific sub-merchant

### Get a sub-merchant's payouts.

 - [GET /merchants/{merchantId}/payouts](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1%7Bmerchantid%7D~1payouts/get.md): Retrieve the payouts for a specific sub-merchant.

### Get the details of a specific sub-merchant payout.

 - [GET /merchants/{merchantId}/payouts/{payoutId}](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1%7Bmerchantid%7D~1payouts~1%7Bpayoutid%7D/get.md): Retrieve the details of a specific payout for a sub-merchant.

### Get transactions for a specific sub-merchant payout.

 - [GET /merchants/{merchantId}/payouts/{payoutId}/transactions](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1%7Bmerchantid%7D~1payouts~1%7Bpayoutid%7D~1transactions/get.md): Retrieve the transactions associated with a specific payout for a sub-merchant. Transactions can be of type PAYMENT or REFUND.

### Get sub-merchant API key

 - [GET /merchants/{merchantId}/api-key](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1%7Bmerchantid%7D~1api-key/get.md): Retrieve the API key information for a sub-merchant. This is a temporary endpoint and will be deprecated in the future. Useful to create payments on behalf of your sub-merchants.

### Get merchant volumes

 - [GET /merchants/volumes](https://docs.helix-pay.net/apis/external.gen/sub-merchants/paths/~1merchants~1volumes/get.md): Get gross and net volumes for all your sub-merchants for a specified date and currency. If no date is provided, it defaults to the previous full day.

## Other

### Health check endpoint

 - [GET /health](https://docs.helix-pay.net/apis/external.gen/paths/~1health/get.md): A simple endpoint to check the health of the API