Sign in

v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Deposits

Get a Deposit Customer (by Token)

Retrieves a customer linked to a specific deposit using the depositCustomerToken.

get/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.

Response

The deposit customer was retrieved successfully

idstring

Unique identifier of the deposit customer.

depositobject

The enriched deposit object with currencies, company, and creator details.

customerIdstring

The merchant-provided customer identifier.

customerEmailstring

Email address of the customer, if provided.

tokenstring

Unique token identifying this deposit customer session.

typestring

Type of deposit customer (e.g. DEPOSIT).

recipientPublicKeysstring[]

List of recipient public keys.

defaultOnrampAmountnumber nullable

Default on-ramp amount, if configured.

requiredAmountMinimalUnitstring nullable

Required deposit amount in minimal token units.

requiredAmountDecimalsnumber nullable

Number of decimals for the required amount.

pricingCurrencyIdstring nullable

ID of the pricing currency, if set.

remainingDueMinimalUnitstring nullable

Remaining amount due in minimal token units.

disabledboolean

Whether this deposit customer is disabled.