Skip to content

Search documentation

Try “webhook signature” or “amountUsd”. Use Tab or arrow keys to explore results.

    Open app
    Open app

    Documentation navigation

    Stores

    Read store identity, branding and accepted-origin settings.

    On this page

    List stores

    GET/v1/profiles/{profileId}/stores

    Authentication: Bearer key · Required scope: stores.read

    No query parameters or body. Send Authorization: Bearer with your server key. Returns 200 with {stores: […]}, first-created store first. A store-scoped key sees only its store.

    Path parameters
    FieldDetails
    profileIdpath · required UUIDThe profile that owns your API key.

    Store response

    Manage stores in the app. A secret API key has stores.read only and cannot create or edit stores.

    Stores in one merchant profile share the profile wallet. They do not provide seller-specific settlement.

    Store response
    FieldDetails
    storeId, nameUUID, stringPublic project identity and display name. The ID does not authorize access.
    defaultExpiresInintegerDefault checkout lifetime in seconds.
    allowedOriginsstring[]Exact origins allowed to embed checkout and receive approved returns.
    tokensOff{chainId, token}[]Enabled assets this store does not accept.
    brandColor, logoAtstring | nullStore branding and logo timestamp.
    updatedAttimestampLast change in RFC 3339 format.

    Errors

    Responses use {error: {code, message}}. Missing or invalid credentials return 401; missing scope or a different profile returns 403. Objects outside the caller’s store or mode are hidden with 404.

    Invalid values return 422 invalid_value. Rate limiting returns 429 rate_limited with Retry-After. A starting network can return 503 network_not_ready; an unexpected server error returns 500 internal.

    Forwend documentation Test first. Confirm on your server.