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