Generate a user deposit address

curl --request POST \ --url https://app.alphapo.net/api/v2/addresses/take \ --header 'Content-Type: application/json' \ --header 'X-Processing-Key: <api-key>' \ --header 'X-Processing-Signature: <x-processing-signature>' \ --data ' { "currency": "USDC", "foreign_id": "user_12345", "end_user_reference": "user_12345" } '

{ "data": { "id": 3859599, "currency": "USDC", "address": "0x35f6005cfA94a1c030B8c4dfcc29D4eB8a6865bF", "tag": null, "foreign_id": "user_12345", "end_user_reference": "user_12345" } }

Authorizations

X-Processing-Key

string

header

required

Your API key.

Headers

X-Processing-Signature

string

required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Body

application/json

currency

string

required

The currency to receive. For a list of all available currencies, see API currency codes.

foreign_id

string

required

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.

convert_to

string

Automatically convert all deposits to this currency. If omitted, no automatic conversion is applied.

end_user_reference

string

Permanent ID of the customer in your system. Used to group, track, and analyze transactions made by a specific customer. Must not contain personal data, such as the user's name or email address.

amount

number

Lightning invoice amount.

Required only when currency is BTCLN.
Specify up to 8 decimal places.
Retrieve the minimum and maximum amounts from the /currencies/list endpoint.
The invoice can be paid only for this exact amount.

Response

Created

data

object

Show child attributes