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 need to provide your tag. If you don't provide a tag, your deposit will be lost. For more details, see What is a destination tag or memo?.

User identifier provided within the end_user_reference parameter will be used for aggregating and analysing the operations and activities performed by certain user. Make sure to provide the correct unique id of the appropriate users within this parameter. Providing wrong data may lead to unexpected transactions delays or their blocking. Please make sure your user id does not contain personal data.

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.

Header parameters
X-Processing-KeystringRequired

Private key

X-Processing-SignaturestringRequired

Private secret key

Body
end_user_referencestringOptional

The persistent ID of the end user. Must not contain personal data, such as the user's name or email address.

currencystringRequired
Currency you want to receive money in. 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 here. For a list of all available currencies, see Supported currencies.

tagintegerOptional

If you want to receive or convert to XRP, you need to specify your tag. If you don't, you risk losing the deposit. If you're working with any other currencies, you don't need to specify this parameter.

foreign_idstring · max: 255Required

Your info for this address, will returned as reference in Address responses, example: user-id:2048. Must not contain personal data, such as the user's name or email address.

Responses
200
OK
application/json
post
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: 65

{
  "currency": "string",
  "convert_to": "string",
  "foreign_id": "string"
}
{
  "data": {
    "id": 23553829,
    "currency": "BTC",
    "address": "2NFZ9SmEm3mQ7jqVF4vPXBwCyn9KpmEwkTj",
    "tag": "string",
    "foreign_id": "postman_auto_test_new_BTC_address",
    "end_user_reference": "postman_auto_test_user"
  }
}

Get address as QR code

get

Get a QR code for your crypto address.

Query parameters
addressstringRequired

The address you're generating this QR code for.

currencystringRequired

The ISO of the cryptocurrency you want to receive.

tagstringOptional
If this is a XRP address, you need to provide your tag. If you don't provide a tag, your deposit will be lost. For more details, see What is a destination tag or memo?.
Header parameters
X-Processing-KeystringRequired

Private key

X-Processing-SignaturestringRequired

Private secret key

Responses
200
OK
application/json
get
GET /api/v2/addresses/qrcode HTTP/1.1
Host: app.cryptoprocessing.com
X-Processing-Key: text
X-Processing-Signature: text
Accept: */*
{
  "data": {
    "qrcode": "2MxYnENSKFiYv51eMM87rkZ5nSAn41pZESp"
  }
}

Was this helpful?