Get User's Save Points for Swag Settings and Balance

Retrieves a loyalty user's "Save Points for Swag" banking preferences, including the save-points opt-in status, configured threshold, and the number of points currently accumulated toward swag redemption.

Prerequisites

The business must have the "Save Points for Swag" feature enabled in the Punchh platform.
The business must support banked point debit.

If either condition is not met, the endpoint returns a 422 Unprocessable Entity error.

Note: Contact your Punchh representative to update this Punchh platform configuration.

See Update User's Save Points for Swag Settings, Fetch Available User's Swag, Redeem Swag, and Get Swag Shipping Details.

Headers

Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
x-pch-digest
Type: string
required

The signature for the API call
Content-Type
Type: string
required

Set this header to application/json.
Accept
Type: string
required

Advertises which content types the client is able to understand
User-Agent
Type: string
required

Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.
punchh-app-device-id
Type: string
required

The app device ID helps Punchh identify each device so that certain rewards can be awarded individually to each device instead of per user. For example, the sign-up reward is given to each device ID to prevent fraudulent sign-ups so that a user cannot do repeated sign-ups from a single device to get rewards. It should not change even if the user resets a device. See the sample code to generate the punchh-app-device-id header.

Body

application/json

client
Type: string
required

OAuth client ID provided by the business

Responses

application/json
application/json
application/json
application/json
application/json

get/api2/mobile/user_banking_preferences

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/mobile/user_banking_preferences \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --header 'x-pch-digest: {{$$.env.signature}}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'User-Agent: AppName/AppVersion/BuildNumber (OS; Model; MANUFACTURER; MODEL; OS Version)' \
  --header 'punchh-app-device-id: APP_DEVICE_ID_GOES_HERE' \
  --data '{
  "client": "CLIENT_KEY_GOES_HERE"
}'

Show Schema

{
  "save_points_for_swag_enabled": false,
  "saved_swag_points_threshold": 0,
  "swag_balance": 0
}