Skip to main content
Returns a receiving address for a supported currency and network pair. Incoming transactions to the address trigger webhook callbacks with type: Static.

Headers

string
required
Your active Vanryx API key. See API keys and authentication.
string
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

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
string
Result message.

Errors

See Errors and integration notes.