Skip to main content

How to get a deposit address for a Customer

Overview​

Customer purse address API allows you to get a reusable deposit address for a customer and a selected currency.

Use this guide after creating a customer. The returned purse address can be used for crypto deposits.

Integration flow​

  1. Create a customer and save the returned customer id.
  2. Get a customer purse address by using the method - [POST] customer-purse/address/get
  3. Save the returned purse id, address, and available currencies in your system.
  4. Optionally get all customer purses by using the method - [POST] customer-purse/purse/get-all

Sequence​

Names of requests on the scheme indicate Customer Purse API methods.

Customer address sequence

API methods​

Get customer purse address - [POST] customer-purse/address/get​

Request fields​

FieldTypeRequiredDescription
accountstringYesMerchant account ID. The request will be sent for this account.
timestampnumberYesCurrent Unix UTC timestamp in milliseconds. The value must not be less than 3 minutes in the past or greater than 3 minutes in the future.
payloadobjectYesObject with customer ID and currency.

Payload fields​

FieldTypeRequiredDescription
customerIdstringYesCalypso customer ID.
currencystringYesCurrency ticker used to request a purse address.

Request example​

{
"account": "0x0000000000000000000000000000000000000000",
"timestamp": 1761650432438,
"payload": {
"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "USDT_TRX"
}
}

Response fields​

FieldTypeDescription
idstringCustomer purse ID.
addressstringCustomer deposit address.
currenciesarrayCurrencies available for this purse address.
createdDatestringDate and time when the purse was created.

Response example 200 OK​

{
"id": "52bc94ac-7bac-49f0-a476-ac64c6634381",
"address": "0x8ab54579efb614b9c46fb36db6a753df2cd18d65",
"currencies": [
"USDT_TRX"
],
"createdDate": "2026-06-29T09:00:00.000Z"
}

Get customer purses - [POST] customer-purse/purse/get-all​

FieldTypeRequiredDescription
customerIdstringYesCalypso customer ID.

The response contains the purses array. Each purse object contains id, address, currencies, and createdDate.

Address lifecycle​

CaseDescription
Address is generatedThe customer can use the address for supported currency deposits.
Address has no depositsIf the address has not been funded for 30 days, it expires and Calypso sends CUSTOMER_PURSE_EXPIRED.
Address receives a confirmed depositThe address lifetime is extended for another 12 months from the last confirmed incoming deposit.
Address expiresThe merchant receives CUSTOMER_PURSE_EXPIRED and should request a new address if the customer needs to continue depositing.
DocumentLink
Create customerHow to create a Customer
Process customer transactionsHow to process Customer transactions
Customers webhooksCustomers webhooks
Customer Purse API referenceCustomer Purse API