Skip to main content
GET
Get Deposits
Note: When using the production environment at moonpay.hel.io, set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from moonpay.dev.hel.io.

Authorizations

Authorization
string
header
required

Authentication using JWT token

Query Parameters

name
string

Optional deposit name to filter results by. Multiple deposits may be returned as names are not unique.

apiKey
string
required

Your API key, which can be generated from the Helio Dashboard settings page.

Response

List of deposits retrieved successfully.

id
string
required

Unique identifier of the deposit configuration.

name
string
required

Human-readable name of the deposit configuration.

platform
string
required

Platform associated with the deposit configuration.

notifyReceiverByEmail
boolean
required

Whether the receiver should be notified by email.

disabled
boolean
required

Indicates whether the deposit configuration is disabled.

connectWalletOptions
object
required
transferManuallyOptions
object
required
payWithCardOptions
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required