Skip to main content
PATCH
/
v1
/
deposit-customers
/
{depositCustomerToken}
/
api-key
Update Deposit Customer
curl --request PATCH \
  --url https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipientPublicKeys": [
    "<string>"
  ],
  "disabled": true,
  "additionalJSON": "<string>"
}
'
{
  "id": "68f8c78f600865f76e7cc866",
  "deposit": "68f25d8ebe91855f9fad444b",
  "token": "ba065c1b-9134-4a68-9bfc-104e5c1c7631",
  "customerId": "customerId",
  "recipientPublicKeys": [
    "7YancRyN3yp9s6G7YNwx9H93UqswoKFqF9GuNJPufyvW"
  ]
}
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

​
depositCustomerToken
string
required

The token associated with the deposit customer to retrieve.

Query Parameters

​
apiKey
string
required

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

Body

application/json
​
recipientPublicKeys
string[]

List of recipient public keys.

​
disabled
boolean

Indicates whether the deposit customer is enabled or disabled. Set to true to disable, or false to enable.

​
additionalJSON
string

Optional JSON string containing metadata.

Response

The deposit customer was updated successfully

​
recipientPublicKeys
string[]

List of recipient public keys.

​
disabled
boolean

Indicates whether the deposit customer is enabled or disabled. Set to true to disable, or false to enable.

​
additionalJSON
string

Optional JSON string containing metadata.