Skip to main content
This API allows you to create and manage cryptocurrency addresses for receiving payments.

The crypto address object

string
Unique identifier with addr_ prefix (e.g., addr_abc123def456).
string
Always "crypto_address".
string
The cryptocurrency address.
string
Currency code (e.g., BTC, ETH).
string
The wallet ID this address belongs to.
object
Blockchain explorer information.
string
When the address was created (ISO 8601).
string
When the address was last updated (ISO 8601).

List crypto addresses

Retrieves a paginated list of all crypto addresses in your account. Addresses are ordered by creation date (newest first).
integer
default:"1"
Page number for pagination. Results are returned 25 items per page.
Response

Get crypto address

Retrieves a specific crypto address by ID.
string
required
The address’s ID (e.g., addr_abc123def456).
Response

Create crypto address

Creates a new crypto address in a wallet. The wallet can be either an account wallet or a customer wallet.
string
required
The wallet’s ID (e.g., wall_xyz789). Must belong to your account.
string
required
The currency code (e.g., BTC, ETH). Must be a supported currency.
string
required
The cryptocurrency address. Validated based on the currency format.
Response

Error responses

Wallet not found
Unsupported currency
Duplicate address

Delete crypto address

Deletes a crypto address from your account.
Deleting an address will also delete any associated payment claims and transaction records.
string
required
The address’s ID (e.g., addr_abc123def456).
Returns 204 No Content on successful deletion.

Address validation

Addresses are validated based on their currency:
  • BTC: Validates Bitcoin address formats (legacy, SegWit, native SegWit).
  • ETH: Validates Ethereum address format (0x followed by 40 hex characters).

Supported currencies

Sandbox support

The API respects sandbox scoping. If your API token is associated with a sandbox, you can only access addresses created in that sandbox. Address uniqueness is enforced separately within each sandbox.