Skip to main content

Deposit addresses

Base path: /v1/deposit-addresses. Requires authentication.

MethodPathDescription
POST/v1/deposit-addressesCreate or fetch a deposit address for a customer.
GET/v1/deposit-addressesList your deposit addresses (paginated).
GET/v1/deposit-addresses/:idGet one deposit address.

Create or fetch​

POST body accepts:

FieldRequiredDescription
chainIdyesChain from Chains.
remoteCustomerIdnoYour customer identifier.
metadatanoOpaque JSON attached to the address.

When remoteCustomerId is supplied, the call is idempotent: the same customer and chain always resolve to the same address.

Give the returned address to your customer. Incoming transfers are detected automatically — see Deposits.