Skip to main content
PATCH
Child Address Update Rule

Autorizaciones

x-api-key
string
header
requerido

Parámetros de ruta

walletId
string
requerido
Ejemplo:

"{{walletId}}"

addressId
string
requerido
Ejemplo:

"534e0480-f444-40c0-bc2e-2ef17bf7999e"

id
string
requerido
Ejemplo:

"55869cbe-fa3a-44d2-a7e3-d65c08355e4d"

Cuerpo

application/json
destination
object
requerido
source
object
requerido
productKey
string

Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset.

type
enum<string>

Settlement rule type. Sending it on an update migrates a legacy rule onto the explicit type system; omit it to keep the rule's current behavior.

Opciones disponibles:
withdraw,
swap,
gateway,
earn
Ejemplo:

"swap"

isActive
boolean

Resets to true when omitted.

Ejemplo:

true

isGateway
boolean

Must be true when the rule's type is gateway.

Ejemplo:

false

isReward
boolean

Must be true when the rule's type is earn. Mainnet only, and cannot be combined with isGateway.

Ejemplo:

false

rewardProvider
enum<string>

Required whenever isReward is true.

Opciones disponibles:
aave,
compound
Ejemplo:

"aave"

rewardType
enum<string>

Only defi is currently offered.

Opciones disponibles:
defi
Ejemplo:

"defi"

useTransactionAmount
boolean

false settles the address's current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted.

Ejemplo:

false

deductionPercentage
string

Percentage withheld from the settled amount before execution. Resets to "0" when omitted.

Ejemplo:

"0"

name
string
Ejemplo:

"Swap from USDT to OP USDC"

order
enum<string>

Resets to RECOMMENDED when omitted.

Opciones disponibles:
FASTEST,
CHEAPEST,
RECOMMENDED,
NO_SLIPPAGE
Ejemplo:

"FASTEST"

slippageTolerance
string

Resets to "0" when omitted.

Ejemplo:

"5"

Respuesta

200 - application/json

200

data
object
message
string
Ejemplo:

"Auto settlement rule updated successfully"

statusCode
number
Ejemplo:

200