Skip to main content
PUT
Register your payout destination for one deployment

Authorizations

x-api-key
string
header
required

Headers

x-idempotency-key
string<uuid>
required

Unique key (UUID) to ensure request idempotency on POST, PUT and PATCH requests.

A key is scoped to your client, the HTTP method and the path, and is remembered for 24 hours after a successful (below 400) response. Repeating the same request (same JSON body, whatever the key order or whitespace) with the same key within that window returns the original response with X-Idempotent-Replayed: true instead of executing the request again. Using the same key on the same endpoint with a different body returns 422 with problem type idempotency-key-reused; the request is not executed. Error responses (4xx and 5xx) are not remembered, so a request refused for a fixable reason can be corrected and retried under the same key. Request bodies that are not JSON (for example file uploads) are not compared.

Path Parameters

asset
string
required

The asset the payout is made in: RD, or a branded token your client owns.

network
enum<string>
required

The network of the deployment. A deployment's payout is sent on its own network, so this names which deployment the destination is for rather than offering a choice of chain. Identifier for a blockchain network

Available options:
ethereum-mainnet,
ethereum-sepolia,
ethereum-goerli,
ethereum-holesky,
solana-mainnet,
solana-devnet,
solana-testnet,
base-mainnet,
base-sepolia,
arbitrum-mainnet,
arbitrum-sepolia,
optimism-mainnet,
optimism-sepolia,
polygon-mainnet,
polygon-amoy
Required string length: 1 - 30
Example:

"ethereum-mainnet"

Body

application/json

The wallet to send one deployment's payouts to.

address
string
required

An address on the deployment's network.

Example:

"0x1234567890123456789012345678901234567890"

Response

The registered destination.

A client's registered payout destination for one deployment, an asset on a network.

asset
string
required

The asset the payout is made in.

Example:

"RD"

network
enum<string>
required

Identifier for a blockchain network

Available options:
ethereum-mainnet,
ethereum-sepolia,
ethereum-goerli,
ethereum-holesky,
solana-mainnet,
solana-devnet,
solana-testnet,
base-mainnet,
base-sepolia,
arbitrum-mainnet,
arbitrum-sepolia,
optimism-mainnet,
optimism-sepolia,
polygon-mainnet,
polygon-amoy
Required string length: 1 - 30
Example:

"ethereum-mainnet"

chain
string
required

CAIP-2 chain id of the deployment's network.

Example:

"eip155:8453"

address
string
required
updated_at
string<date-time>
required