Create a Deposit Address

Get deposit address

post

This API endpoint generates or retrieves a unique deposit address for a specific user and currency. The returned address can be used by the user to send funds from personal wallets into the merchant platform.

Body

Request to get deposit address

currency_idstringRequired

Currency ID, which can be retrieved using supported currencies.

user_reference_idstringRequired

The unique user reference to identify a user for transaction tracking

Responses

200

Deposit address generated

application/json

Response containing deposit address information

currencystringRequired

Currency name

currency_codestringRequired

Currency code

networkstringRequired

Blockchain network

wallet_addressstringRequired

Deposit wallet address

422

Validation error - Invalid currency_id format (must be valid UUID), user_reference_id contains invalid characters (only alphanumeric, hyphens, and underscores allowed), or user_reference_id exceeds 50 character limit

application/json

500

Unexpected error occurred

application/json

post/v1/user/deposit/address

POST /v1/user/deposit/address HTTP/1.1
Host: gateway.stage.pay.io
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "currency_id": "c872e749-fd56-533e-b01f-de87ae38e7f1",
  "user_reference_id": "hub_player_2"
}

{
  "currency": "USD Coin",
  "currency_code": "USDC",
  "network": "Base Chain",
  "wallet_address": "0x1234567890123456789012345678901234567890"
}

---