Deposit addresses

Generate a crypto address

post

Create a crypto deposit address you can share with clients. Optionally, you can automatically convert all deposits you receive to a currency of your choice.

If you're receiving or converting to XRP, you will receive a tag in the response that you must display to the customer alongside their address. Any XRP deposits sent without a tag may be lost. For more details, see What is a destination tag or memo?.

If you want to automatically convert all deposits to a currency of your (or your customer's) choice, specify its ISO code in the convert_to parameter.

The end_user_reference parameter is used to group, track and analyse transactions made by a specific customer. To prevent transactions from getting delayed or cancelled, always make sure to include the correct ID. The ID must not contain any personal or identifying customer data.

Note: Cryptoprocessing is required to collect sender data in compliance with the MiCA regulations. For more details, see About user data collection. The sender_data and the end_user_reference you provide must be associated with the same customer.

Header parameters

X-Processing-KeystringRequired

Private key

X-Processing-SignaturestringRequired

Private secret key

Body

application/json

end_user_referencestringRequired

Permanent ID of the customer in your system. Must not contain personal data, such as the user's name or email address. Include this customer's data in the sender_data object.

currencystringRequired

The currency you want to receive. For a list of all available currencies, see Supported currencies.

convert_tostringOptional

If you need to automatically convert all deposits to a certain currency, specify its ISO code here. For a list of all available currencies, see Supported currencies.

foreign_idstringRequired

The unique ID of the customer who will be depositing to this address. It will be returned with every callback to make it easy for you to identify the customer within your system. The same foreign_id can be reused across multiple addresses that belong to the same customer. This parameter must not include any personal data.

sender_typestring · enumRequired

Whether the sender is a natural person (natural) or a legal entity (legal).

Possible values:

Responses

200

OK

application/json

400

Invalid currency

application/json

403

Bad key header

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/addresses/take HTTP/1.1
Host: app.cryptoprocessing.com
X-Processing-Key: text
X-Processing-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "currency": "BTC",
  "end_user_reference": "guest_user_17",
  "convert_to": "EUR",
  "foreign_id": "new_BTC_address_1714",
  "sender_type": "legal",
  "sender_data": {
    "legal_name": "Example GmbH",
    "country_of_registration": "DEU"
  }
}

{
  "data": {
    "id": 23553829,
    "currency": "BTC",
    "address": "2NFZ9SmEm3mQ7jqVF4vPXBwCyn9KpmEwkTj",
    "tag": null,
    "foreign_id": "new_BTC_address12",
    "end_user_reference": "guest_user_17"
  }
}