v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Deposits

Create a Customer for a Deposit

Creates a new customer linked to a specific deposit using the depositId

post/v1/deposit-customers/api-key

Query parameters

apiKeystring required

Your API key can be generated on the Helio Dashboard’s settings page.

Request body

customerIdstring required

Merchant-defined unique identifier used to reference the customer in the merchant’s system.

depositIdstring required

Identifier of the deposit.

recipientPublicKeysstring[] required

List of recipient public keys.

defaultOnrampAmountinteger

The default on-ramp amount to prefill for the customer.

customerEmailstring

Prefills the email field in the MoonPay on-ramp widget for the customer.

additionalJSONstring

Optional JSON string containing metadata.

blockchainEngineTypesstring[]

Optional list of blockchain engines to provision deposit wallets for. When omitted, wallets are created for all supported engines (SOL, BTC, EVM, TRON, HYPERCORE, DOGE). Use this to limit which deposit addresses are generated — for example, pass ["EVM", "BTC"] to skip SOL if you handle Solana deposits yourself.

Response

The deposit customer was created successfully

customerIdstring required

Merchant-defined unique identifier used to reference the customer in the merchant’s system.

depositIdstring required

Identifier of the deposit.

recipientPublicKeysstring[] required

List of recipient public keys.

defaultOnrampAmountinteger

The default on-ramp amount to prefill for the customer.

customerEmailstring

Prefills the email field in the MoonPay on-ramp widget for the customer.

additionalJSONstring

Optional JSON string containing metadata.

blockchainEngineTypesstring[]

Optional list of blockchain engines to provision deposit wallets for. When omitted, wallets are created for all supported engines (SOL, BTC, EVM, TRON, HYPERCORE, DOGE). Use this to limit which deposit addresses are generated — for example, pass ["EVM", "BTC"] to skip SOL if you handle Solana deposits yourself.