Sign in
Payments

Register a payout address

Changed on

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

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/x402/payout-addresses
  • Auth: HTTP bearer

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

successboolean required

Changes

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

  • 22d1dfc68434Revision changes
    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status