Add a payout address
Accepts chain, address, and a fresh exact-action emailed 2FA challenge; during reset cooldown the address remains inactive until effectiveAt.
Authorizations
Secret partner API key (sk_live_… or sk_test_…). Required to create or manage payment sessions. Server-side only — it can move money, so it must never reach a browser bundle. The key's prefix also selects the environment: sk_test_ is confined to testnets.
Body
Response
Payout address change accepted.
W3C trace id of the request — correlate with logs/traces in SigNoz.
"4bf92f3577b34da6a3ce929d0e0e4736"
Domain error code. OK on success; non-OK values come with a non-null error.
OK, BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED, PAYLOAD_TOO_LARGE, UNSUPPORTED_CHAIN, INTERNAL_ERROR, UPSTREAM_TIMEOUT, UPSTREAM_ERROR, SERVICE_UNAVAILABLE, KILL_SWITCH_ACTIVE, CIRCUIT_BREAKER_OPEN, NO_QUOTE_AVAILABLE, QUOTE_STALE, SIMULATION_REVERTED, INVALID_PARAMS, AMOUNT_OUT_OF_BOUNDS, PAYOUT_TOKEN_NOT_ALLOWED, RECIPIENT_NOT_ALLOWLISTED, PAYMENT_EXPIRED, PAYMENT_NOT_FOUND, NOT_CONFIGURED, INSUFFICIENT_LIQUIDITY, ROUTE_TEMPORARILY_UNAVAILABLE, UNSUPPORTED_ROUTE, OVER_DELIVERY_CAP "OK"
Human-readable error message. null on success.
null
Endpoint-specific payload. null on error.