Get Wallet Address
Use this API to get a dedicated deposit address for a specified merchant user in cryptocurrency collection scenarios.
For the same user on the same chain, only one address will be generated (idempotent).
Request
- Method:
POST - Path:
/api/v1/payin/cryptoAddress - Content-Type:
application/json - Auth: Include AppId, Timestamp, and Signature as in Authentication; follow the same signing algorithm
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
merchantUserId | string | Yes | Unique merchant-side user identifier |
chain | string | Yes | Chain type. Enum: ETH, BSC, TRON |
Request example
json
{
"merchantUserId": "velora_1234",
"chain": "BSC"
}Response
Response body has a unified structure: result for request outcome, data for address information.
result object
| Field | Type | Description |
|---|---|---|
code | string | Response code (success/failure) |
msg | string | Message |
data object
| Field | Type | Always returned | Description |
|---|---|---|---|
status | string | Yes | Current processing status. Returns Success on success |
merchantUserId | string | Yes | Unique merchant-side user identifier |
chain | string | Yes | Chain type. Enum: ETH, BSC, TRON |
address | string | Yes | Wallet address assigned to the user on the specified chain |
Response example
json
{
"result": {
"code": "S0000",
"msg": "Address created successfully"
},
"data": {
"status": "Success",
"merchantUserId": "velora_1234",
"chain": "BSC",
"address": "0x8Be0f2577b0018844fF19b675f387CC36605F1B7"
}
}Notes
- Suitable for cryptocurrency collection scenarios
- Repeated requests with the same
merchantUserIdandchainreturn the same address - After getting the address, merchants can guide users to transfer funds to that address
See also
- Authentication: Auth method, signature algorithm, and request format
- Create payment: Payment initiation API for standard payment scenarios
- Payment callback: Async notification and verification