POST https://api.vanryx.com/api/v1/payment/static-address
Returns a receiving address for a supported currency and network pair. Incoming transactions to the address trigger webhook callbacks with type: Static.
Use application/json. The examples send JSON request bodies.
Body parameters
string
required
Maximum 32 characters. Must form a supported pair with network.
string
required
Maximum 32 characters. Must be a supported network paired with to_currency.
boolean
default:"false"
Optional address preference.
string
URL that receives webhook callbacks for this address. Maximum 2,048 characters. Must use HTTP or HTTPS and resolve only to public IP addresses.
string
Valid email address. Maximum 255 characters.
string
Your order reference. Maximum 128 characters.
string
Maximum 128 characters.
string
Maximum 1,000 characters.
Supported pairs
to_currency
network
Notes
BTC
BTC
Bitcoin
LTC
LTC
Litecoin
DOGE
DOGE
Dogecoin
BCH
BCH
Bitcoin Cash
ETH
ETH
Ethereum
BNB
BSC
BSC is presented as BNB on this API pair.
TRON
TRON
Native TRON. TRX with network TRON is also accepted as an alias.
USDT
TRON
TRON token.
SOL
SOL
Solana
XRP
XRP
The response includes a generated Destination Tag.
USDC
ETH
Ethereum token.
A valid pair alone does not ensure that an address can be created. The asset must be active, and your Merchant account must have the required account and address setup.
XRP Destination Tag
For XRP, always show and use the returned destination_tag when it is not null. The receiving address may be shared, so the payer must include the tag. You do not supply the tag: Vanryx generates it.
Response
object
Hide properties
string
Network of the address.
string
Currency of the address.
string
Receiving address.
integer | null
Generated Destination Tag for XRP. Use it whenever it is not null.
null
Currently null. The API does not return a QR image.
integer
Creation time.
string
Result message.
Errors
HTTP status
When
401
Missing merchant API Key or Invalid or inactive API Key.
422
{"message":"Wrong currency code."} for an unsupported currency and network pair.
422
A service message when the Merchant account, active asset, or address setup is unavailable. These messages vary and are not an exhaustive list.