> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hel.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Update a Deposit
> Updates a deposit by ID. Only provided fields are modified, allowing changes to name, description, payment options, disabled state, blockchain symbols, and more.
**Note:** When using the production environment at [moonpay.hel.io](http://app.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](http://app.dev.hel.io).
## OpenAPI
````yaml PATCH /v1/deposits/{depositId}/api-key
openapi: 3.0.0
info:
title: Helio Open API
description: |-
API schema and definitions for Helio API.
The API is using two types of Authentication, for dashboard endpoints we use JSON Web Token (JWT) that is generated by self custodial wallet signing a message from API.
We also support authentication with API Key and Secret which can be generated on Helio dashboard.
version: 1.0.0
contact: {}
servers:
- description: Helio API (Mainnet)
url: https://api.hel.io
- description: Helio API (Devnet)
url: https://api.dev.hel.io
security: []
tags:
- name: Webhooks
- name: Exports
- name: Currencies
description: >-
Supported currencies endpoint, includes fiat and digital assets
Authentication: None
externalDocs:
description: Helio product documentation
url: https://docs.hel.io/
paths:
/v1/deposits/{depositId}/api-key:
patch:
tags:
- Deposits
summary: Update a Deposit
description: >-
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.
operationId: DepositController_updateDeposit
parameters:
- name: depositId
in: path
required: true
description: The unique ID of the deposit to update.
schema:
type: string
- name: apiKey
in: query
required: true
description: >-
Your API key, which can be generated from the Helio Dashboard
settings page.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDeposit'
responses:
'200':
description: Deposit updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/DepositResponse'
examples:
updatedDepositResponse:
summary: Example update deposit response
value:
id: string
name: string
description: string
paylinkId: string
platform: HELIO
notifyReceiverByEmail: true
disabled: false
disabledBlockchainSymbols:
- SOL
- ETH
connectWalletOptions:
isActive: true
title: string
badge: string
order: 1
transferManuallyOptions:
isActive: true
title: string
badge: string
order: 2
payWithCardOptions:
isActive: true
title: string
badge: string
order: 3
hasWhiteListDomain: false
connectExchangeOptions:
isActive: true
title: string
badge: string
order: 4
minSweepAmountUsd: 3
createdAt: '2026-02-06T16:31:18.839Z'
updatedAt: '2026-02-06T16:31:18.839Z'
'401':
description: Provided API key has no access to the resource.
content:
application/json:
examples:
unauthorized:
summary: Invalid or missing API key
value:
message: Api key or token is invalid
code: 401
security:
- bearer: []
components:
schemas:
UpdateDeposit:
type: object
description: Request body for updating a deposit. All fields are optional.
properties:
name:
type: string
description: Name of the deposit.
maxLength: 200
disabled:
type: boolean
description: Whether the deposit is disabled.
description:
type: string
description: Description of the deposit.
maxLength: 200
notifyReceiverByEmail:
type: boolean
description: Send email notifications.
connectWalletOptions:
$ref: '#/components/schemas/DepositPaymentOption'
transferManuallyOptions:
$ref: '#/components/schemas/DepositPaymentOption'
payWithCardOptions:
$ref: '#/components/schemas/DepositPaymentCardOption'
connectExchangeOptions:
$ref: '#/components/schemas/DepositPaymentOption'
disabledBlockchainSymbols:
$ref: '#/components/schemas/disabledBlockchainSymbols'
minSweepAmountUsd:
type: number
description: Minimum sweep amount in USD.
minimum: 3
DepositResponse:
type: object
description: Response body for a deposit.
required:
- id
- name
- platform
- notifyReceiverByEmail
- disabled
- createdAt
- updatedAt
properties:
id:
type: string
description: Unique identifier of the deposit.
name:
type: string
description: Name of the deposit.
description:
type: string
description: Description of the deposit.
paylinkId:
type: string
description: Associated paylink identifier.
platform:
type: string
description: Platform associated with the deposit.
enum:
- HELIO
- MAGIC_EDEN
notifyReceiverByEmail:
type: boolean
description: Whether the receiver is notified by email.
disabled:
type: boolean
description: Whether the deposit is disabled.
disabledBlockchainSymbols:
$ref: '#/components/schemas/disabledBlockchainSymbols'
connectWalletOptions:
$ref: '#/components/schemas/DepositPaymentOption'
transferManuallyOptions:
$ref: '#/components/schemas/DepositPaymentOption'
payWithCardOptions:
$ref: '#/components/schemas/DepositPaymentCardOption'
connectExchangeOptions:
$ref: '#/components/schemas/DepositPaymentOption'
minSweepAmountUsd:
type: number
description: Minimum sweep amount in USD.
minimum: 3
createdAt:
type: string
format: date-time
description: Timestamp when the deposit was created.
updatedAt:
type: string
format: date-time
description: Timestamp when the deposit was last updated.
DepositPaymentOption:
type: object
description: Configuration for a deposit payment option.
properties:
isActive:
type: boolean
description: Whether this option is shown/enabled.
title:
type: string
description: Display title for this option.
badge:
type: string
description: Optional badge label for this option.
order:
type: number
description: Display order for this option.
DepositPaymentCardOption:
type: object
description: Configuration for a deposit payment option.
properties:
isActive:
type: boolean
description: Whether this option is shown/enabled.
title:
type: string
description: Display title for this option.
badge:
type: string
description: Optional badge label for this option.
order:
type: number
description: Display order for this option.
hasWhiteListDomain:
type: boolean
description: Whether a whitelist domain is set.
disabledBlockchainSymbols:
type: array
description: List of blockchain symbols for which deposits are disabled.
items:
type: string
enum:
- SOL
- ETH
- POLYGON
- BASE
- BITCOIN
- ARBITRUM
- BSC
- TRON
- ABSTRACT
- HYPERLIQUID
- HYPERCORE
- PLASMA
uniqueItems: true
default: []
example:
- - SOL
- BASE
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Authentication using JWT token
````