v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB

Deposits

Update a Deposit

Updates an existing deposit by its ID. All fields in the request body are optional — only the provided fields will be updated. This can be used to change the deposit name, description, payment method options, disabled state, blockchain symbols, and more.

patch/v1/deposits/{depositId}/api-key

Path parameters

depositIdstring required

The unique ID of the deposit to update.

Query parameters

apiKeystring required

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

Request body

namestring

Name of the deposit.

disabledboolean

Whether the deposit is disabled.

descriptionstring

Description of the deposit.

notifyReceiverByEmailboolean

Send email notifications.

disabledBlockchainSymbolsstring[]

List of blockchain symbols for which deposits are disabled.

minSweepAmountUsdnumber

Minimum sweep amount in USD.

Example request

{
  "disabledBlockchainSymbols": [
    [
      "SOL",
      "BASE"
    ]
  ]
}

Response

Deposit updated successfully.

idstring required

Unique identifier of the deposit.

namestring required

Name of the deposit.

descriptionstring

Description of the deposit.

paylinkIdstring

Associated paylink identifier.

platform'HELIO' | 'MAGIC_EDEN' required

Platform associated with the deposit.

notifyReceiverByEmailboolean required

Whether the receiver is notified by email.

disabledboolean required

Whether the deposit is disabled.

disabledBlockchainSymbolsstring[]

List of blockchain symbols for which deposits are disabled.

minSweepAmountUsdnumber

Minimum sweep amount in USD.

createdAtstring date-time required

Timestamp when the deposit was created.

updatedAtstring date-time required

Timestamp when the deposit was last updated.

Example response

{
  "disabledBlockchainSymbols": [
    [
      "SOL",
      "BASE"
    ]
  ]
}