Stash Documentation
Integration GuidesAPI ReferencePartner with usChangelog

Set user preferences

Creates or updates the payment channel preference for a user. This is a server-side endpoint and should not be called from the client.

POST
/sdk/server/user_preferences/{userId}

Authorization

X-Stash-Api-Key<token>

DEPRECATED: API key authentication is no longer supported for new shops. Use HMAC authentication via the x-stash-hmac-signature header instead for the best security. Existing shops may continue using their X-Stash-Api-Key for server-to-server operations, but are encouraged to migrate to HMAC as soon as possible.

In: header

Path Parameters

userIdstring

User ID (external user ID from the game/application). Extracted from URL path.

Request Body

paymentChannelpie.sdk.user_preferences.PaymentChannel

Payment channel preference (STASH_PAY or NATIVE_IAP)

Default"UNSPECIFIED"
Value in"UNSPECIFIED" | "STASH_PAY" | "NATIVE_IAP"

Response Body

curl -X POST "https://test-api.stash.gg/sdk/server/user_preferences/string" \  -H "Content-Type: application/json" \  -d '{    "paymentChannel": "UNSPECIFIED"  }'
{}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?

Get user preferences GET

Retrieves the payment channel preference for a specific user. Returns 404 NotFound if no preference is set.

Approve custom login POST

Used to approve custom login requests using JWT authentication (For exampe Apple ID, Google or other JWT based login providers). This is a server-side endpoint and should not be called from the client.