Sign in
Reward Addresses

Update a reward address

Updates an existing reward address

put/rewards/addresses/{id}

Path parameters

idstring required

id is the address ID used as the URL path parameter. Must match address.id when both are provided.

Request body

customer_idstring
ledger'PAXOS' | 'ETHEREUM' | 'SOLANA' | 'INK' | 'XLAYER' | 'ARBITRUM_ONE' | 'ROBINHOOD'

An AttributionLedgerType is a data source which produces events which cause monitored to occur. Examples include blockchains and the Paxos platform. Each event includes a source and/or destination address which will be compared against the addresses configured relative to the same ledger type.

addressstring
namestring
created_atstring date-time
effective_atstring date-time
idstring
payout_group_idstring
balancestring
statusstring

Output only. Registration status (UNREGISTERED, PENDING, ACTIVE, FAILED). Server-managed; ignored on create/update.

asset_typestring

Asset this address is scoped to (e.g. "PYUSD", "USDG").

verification_proof_idstring

Output only. ID of the latest address-ownership proof. Absent when no proof exists.

verification_statusstring

Output only. Status of the latest proof (PENDING, APPROVED, EXPIRED). Absent when no proof exists.

verification_methodstring

Output only. Method of the latest proof (SIGNATURE, SMALL_DEPOSIT, MANUAL). Absent when no proof exists.

verification_expires_atstring date-time

Output only. Expiry of the latest proof. Absent when no proof exists.

Response

A successful response.

Changes

No recorded changes to this endpoint across all 1 revision of this API.