v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Deposits

Update Deposit Customer

Updates a customer associated with a specific deposit using the depositCustomerToken.

patch/v1/deposit-customers/{depositCustomerToken}/api-key

Path parameters

depositCustomerTokenstring required

The token associated with the deposit customer to retrieve.

Query parameters

apiKeystring required

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

Request body

recipientPublicKeysstring[]

List of recipient public keys.

disabledboolean

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

additionalJSONstring

Optional JSON string containing metadata.

Response

The deposit customer was updated successfully

recipientPublicKeysstring[]

List of recipient public keys.

disabledboolean

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

additionalJSONstring

Optional JSON string containing metadata.