Skip to main content
GET
Get a Deposit Customer (by customerId)

Authorizations

Authorization
string
header
required

Authentication using JWT token

Path Parameters

depositId
string
required

The unique ID of the deposit.

customerId
string
required

The unique ID of the customer associated with the deposit.

Query Parameters

apiKey
string
required

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

Response

The deposit customer was retrieved 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.