Skip to main content
POST
/
addresses
/
take
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": "BTC",
  "foreign_id": "test_foreign_id",
  "end_user_reference": "test_end_user_reference"
}
'
{
  "data": {
    "id": 240407213,
    "currency": "BTC",
    "address": "tb1qfdxh6gkfr0qgyatnlkd8khcnxph9tw06n6qwjc",
    "tag": null,
    "foreign_id": "test_foreign_id",
    "end_user_reference": "test_end_user_reference"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.alphapo.net/llms.txt

Use this file to discover all available pages before exploring further.

Deposits sent to this address are attributed to the user identified by foreign_id.

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.

​
end_user_reference
string
required

A persistent internal user ID used to track all requests for the same end user. Must be consistent across requests and must not contain personal data, such as the user's name or email address.

​
convert_to
string

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

​
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
Last modified on May 4, 2026