Update a Deposit

curl --request PATCH \
  --url https://api.hel.io/v1/deposits/{depositId}/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "disabled": true,
  "description": "<string>",
  "notifyReceiverByEmail": true,
  "connectWalletOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123
  },
  "transferManuallyOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123
  },
  "payWithCardOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123,
    "hasWhiteListDomain": true
  },
  "connectExchangeOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123
  },
  "disabledBlockchainSymbols": [
    [
      "SOL",
      "BASE"
    ]
  ],
  "minSweepAmountUsd": 4
}
'

import requests

url = "https://api.hel.io/v1/deposits/{depositId}/api-key"

payload = {
    "name": "<string>",
    "disabled": True,
    "description": "<string>",
    "notifyReceiverByEmail": True,
    "connectWalletOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123
    },
    "transferManuallyOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123
    },
    "payWithCardOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123,
        "hasWhiteListDomain": True
    },
    "connectExchangeOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123
    },
    "disabledBlockchainSymbols": [["SOL", "BASE"]],
    "minSweepAmountUsd": 4
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    disabled: true,
    description: '<string>',
    notifyReceiverByEmail: true,
    connectWalletOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
    transferManuallyOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
    payWithCardOptions: {
      isActive: true,
      title: '<string>',
      badge: '<string>',
      order: 123,
      hasWhiteListDomain: true
    },
    connectExchangeOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
    disabledBlockchainSymbols: [['SOL', 'BASE']],
    minSweepAmountUsd: 4
  })
};

fetch('https://api.hel.io/v1/deposits/{depositId}/api-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hel.io/v1/deposits/{depositId}/api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'disabled' => true,
    'description' => '<string>',
    'notifyReceiverByEmail' => true,
    'connectWalletOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123
    ],
    'transferManuallyOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123
    ],
    'payWithCardOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123,
        'hasWhiteListDomain' => true
    ],
    'connectExchangeOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123
    ],
    'disabledBlockchainSymbols' => [
        [
                'SOL',
                'BASE'
        ]
    ],
    'minSweepAmountUsd' => 4
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hel.io/v1/deposits/{depositId}/api-key"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"disabled\": true,\n  \"description\": \"<string>\",\n  \"notifyReceiverByEmail\": true,\n  \"connectWalletOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"transferManuallyOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"payWithCardOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123,\n    \"hasWhiteListDomain\": true\n  },\n  \"connectExchangeOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"disabledBlockchainSymbols\": [\n    [\n      \"SOL\",\n      \"BASE\"\n    ]\n  ],\n  \"minSweepAmountUsd\": 4\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hel.io/v1/deposits/{depositId}/api-key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"disabled\": true,\n  \"description\": \"<string>\",\n  \"notifyReceiverByEmail\": true,\n  \"connectWalletOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"transferManuallyOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"payWithCardOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123,\n    \"hasWhiteListDomain\": true\n  },\n  \"connectExchangeOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"disabledBlockchainSymbols\": [\n    [\n      \"SOL\",\n      \"BASE\"\n    ]\n  ],\n  \"minSweepAmountUsd\": 4\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hel.io/v1/deposits/{depositId}/api-key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"disabled\": true,\n  \"description\": \"<string>\",\n  \"notifyReceiverByEmail\": true,\n  \"connectWalletOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"transferManuallyOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"payWithCardOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123,\n    \"hasWhiteListDomain\": true\n  },\n  \"connectExchangeOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"disabledBlockchainSymbols\": [\n    [\n      \"SOL\",\n      \"BASE\"\n    ]\n  ],\n  \"minSweepAmountUsd\": 4\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "message": "Api key or token is invalid",
  "code": 401
}

PATCH

deposits

{depositId}

api-key

Update a Deposit

curl --request PATCH \
  --url https://api.hel.io/v1/deposits/{depositId}/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "disabled": true,
  "description": "<string>",
  "notifyReceiverByEmail": true,
  "connectWalletOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123
  },
  "transferManuallyOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123
  },
  "payWithCardOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123,
    "hasWhiteListDomain": true
  },
  "connectExchangeOptions": {
    "isActive": true,
    "title": "<string>",
    "badge": "<string>",
    "order": 123
  },
  "disabledBlockchainSymbols": [
    [
      "SOL",
      "BASE"
    ]
  ],
  "minSweepAmountUsd": 4
}
'

import requests

url = "https://api.hel.io/v1/deposits/{depositId}/api-key"

payload = {
    "name": "<string>",
    "disabled": True,
    "description": "<string>",
    "notifyReceiverByEmail": True,
    "connectWalletOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123
    },
    "transferManuallyOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123
    },
    "payWithCardOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123,
        "hasWhiteListDomain": True
    },
    "connectExchangeOptions": {
        "isActive": True,
        "title": "<string>",
        "badge": "<string>",
        "order": 123
    },
    "disabledBlockchainSymbols": [["SOL", "BASE"]],
    "minSweepAmountUsd": 4
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    disabled: true,
    description: '<string>',
    notifyReceiverByEmail: true,
    connectWalletOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
    transferManuallyOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
    payWithCardOptions: {
      isActive: true,
      title: '<string>',
      badge: '<string>',
      order: 123,
      hasWhiteListDomain: true
    },
    connectExchangeOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
    disabledBlockchainSymbols: [['SOL', 'BASE']],
    minSweepAmountUsd: 4
  })
};

fetch('https://api.hel.io/v1/deposits/{depositId}/api-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hel.io/v1/deposits/{depositId}/api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'disabled' => true,
    'description' => '<string>',
    'notifyReceiverByEmail' => true,
    'connectWalletOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123
    ],
    'transferManuallyOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123
    ],
    'payWithCardOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123,
        'hasWhiteListDomain' => true
    ],
    'connectExchangeOptions' => [
        'isActive' => true,
        'title' => '<string>',
        'badge' => '<string>',
        'order' => 123
    ],
    'disabledBlockchainSymbols' => [
        [
                'SOL',
                'BASE'
        ]
    ],
    'minSweepAmountUsd' => 4
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hel.io/v1/deposits/{depositId}/api-key"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"disabled\": true,\n  \"description\": \"<string>\",\n  \"notifyReceiverByEmail\": true,\n  \"connectWalletOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"transferManuallyOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"payWithCardOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123,\n    \"hasWhiteListDomain\": true\n  },\n  \"connectExchangeOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"disabledBlockchainSymbols\": [\n    [\n      \"SOL\",\n      \"BASE\"\n    ]\n  ],\n  \"minSweepAmountUsd\": 4\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hel.io/v1/deposits/{depositId}/api-key")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"disabled\": true,\n  \"description\": \"<string>\",\n  \"notifyReceiverByEmail\": true,\n  \"connectWalletOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"transferManuallyOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"payWithCardOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123,\n    \"hasWhiteListDomain\": true\n  },\n  \"connectExchangeOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"disabledBlockchainSymbols\": [\n    [\n      \"SOL\",\n      \"BASE\"\n    ]\n  ],\n  \"minSweepAmountUsd\": 4\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hel.io/v1/deposits/{depositId}/api-key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"disabled\": true,\n  \"description\": \"<string>\",\n  \"notifyReceiverByEmail\": true,\n  \"connectWalletOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"transferManuallyOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"payWithCardOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123,\n    \"hasWhiteListDomain\": true\n  },\n  \"connectExchangeOptions\": {\n    \"isActive\": true,\n    \"title\": \"<string>\",\n    \"badge\": \"<string>\",\n    \"order\": 123\n  },\n  \"disabledBlockchainSymbols\": [\n    [\n      \"SOL\",\n      \"BASE\"\n    ]\n  ],\n  \"minSweepAmountUsd\": 4\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "message": "Api key or token is invalid",
  "code": 401
}

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

Path Parameters

depositId

string

required

The unique ID of the deposit to update.

Query Parameters

apiKey

string

required

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

Body

application/json

Request body for updating a deposit. All fields are optional.

name

string

Name of the deposit.

Maximum string length: 200

disabled

boolean

Whether the deposit is disabled.

description

string

Description of the deposit.

Maximum string length: 200

notifyReceiverByEmail

boolean

Send email notifications.

connectWalletOptions

object

Configuration for a deposit payment option.

Show child attributes

transferManuallyOptions

object

Configuration for a deposit payment option.

Show child attributes

payWithCardOptions

object

Configuration for a deposit payment option.

Show child attributes

connectExchangeOptions

object

Configuration for a deposit payment option.

Show child attributes

disabledBlockchainSymbols

enum<string>[]

List of blockchain symbols for which deposits are disabled.

Available options:

SOL,

ETH,

POLYGON,

BASE,

BITCOIN,

ARBITRUM,

BSC,

TRON,

ABSTRACT,

HYPERLIQUID,

HYPERCORE,

PLASMA

Example:

[["SOL", "BASE"]]

minSweepAmountUsd

number

Minimum sweep amount in USD.

Required range: x >= 3

Response

Deposit updated successfully.

Response body for a deposit.

string

required

Unique identifier of the deposit.

name

string

required

Name of the deposit.

platform

enum<string>

required

Platform associated with the deposit.

Available options:

HELIO,

MAGIC_EDEN

notifyReceiverByEmail

boolean

required

Whether the receiver is notified by email.

disabled

boolean

required

Whether the deposit is disabled.

createdAt

string<date-time>

required

Timestamp when the deposit was created.

updatedAt

string<date-time>

required

Timestamp when the deposit was last updated.

description

string

Description of the deposit.

paylinkId

string

Associated paylink identifier.

disabledBlockchainSymbols

enum<string>[]

List of blockchain symbols for which deposits are disabled.

Available options:

SOL,

ETH,

POLYGON,

BASE,

BITCOIN,

ARBITRUM,

BSC,

TRON,

ABSTRACT,

HYPERLIQUID,

HYPERCORE,

PLASMA

Example:

[["SOL", "BASE"]]

connectWalletOptions

object

Configuration for a deposit payment option.

Show child attributes

transferManuallyOptions

object

Configuration for a deposit payment option.

Show child attributes

payWithCardOptions

object

Configuration for a deposit payment option.

Show child attributes

connectExchangeOptions

object

Configuration for a deposit payment option.

Show child attributes

minSweepAmountUsd

number

Minimum sweep amount in USD.

Required range: x >= 3

Create a Deposit Get Deposits

⌘I

API

WALLET

CURRENCY

PAY LINKS

TRANSACTIONS

SUBSCRIPTIONS

CHARGES

DEPOSITS

WITHDRAWALS

WEBHOOKS

HEADLESS PAYMENTS

ALLOW LIST

PLATFORM

EXPORTS

Update a Deposit

Authorizations

Path Parameters

Query Parameters

Body

Response