v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB

Payments

Register a payout address

Register (or update) the default payout address your org receives x402 payments at, for a given network. You prove control of the address with an org-bound personal_sign signature over the message produced by the SDK helper buildPayoutRegistrationMessage. The org id is taken from your authenticated key, never the body, so a captured signature can't register an address under another org. Exactly one default address exists per (org, network); registering again replaces it. A payee MUST register a payout address before calling createChallenge, because the challenge's pay_to is resolved from this directory.

post/x402/payout-addresses

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

addressstring required

The payout address (your signer's own EVM address), 0x-prefixed.

network'base' | 'base-sepolia' required

The chain the address receives on.

signaturestring required

A personal_sign signature over the org-bound message produced by the SDK helper buildPayoutRegistrationMessage. Recovered and checked against address; the org id is bound into the signed bytes.

issued_atstring date-time required

ISO-8601 timestamp embedded in the signed message. Must be within a short freshness window (about 10 minutes) of server time.

labelstring

Optional human-readable label.

Response

Payout address registered (or updated) and set as default

successtrue required