chain.deposit.v1.DepositAddressService

CreateDepositAddress

Create or return the assigned deposit address for one target and source chain. The acting caller's root account must have accepted the current terms, including requests using an API key or targeting a shared subaccount. Otherwise FailedPrecondition is returned. Listing and using existing deposit addresses remain available without acceptance. FailedPrecondition is also returned when deposits on the requested chain are unavailable.

Method

POST

Path

chain.deposit.v1.DepositAddressService/CreateDepositAddress

Service

chain.deposit.v1.DepositAddressService

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

POST

chain.deposit.v1.DepositAddressService/CreateDepositAddress

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/chain.deposit.v1.DepositAddressService/CreateDepositAddress' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "chainId": 1,
  "subaccountId": "6789012345678"
}'

Responses

{
  "depositAddress": {
    "chainId": 1,
    "depositAddress": "0x7777777777777777777777777777777777777777"
  }
}

Request

chain.deposit.v1.CreateDepositAddressRequest

Response

chain.deposit.v1.CreateDepositAddressResponse

subaccountId string (fixed64) > 0

Optional public subaccount ID. When omitted, subaccount-scoped API keys use their bound subaccount; other callers use their authenticated root account.

chainId integer (int32) > 0

PolyChain-registered source chain id to assign the deposit address for.

2 fields

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.