List wallet programs

A seller has at most one active PointsProgram and one active CreditProgram. Each program automatically covers every shop under the seller.

GET/wallet_programs

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

seller_idintegerrequired

typestring

Allowed:pointscredit

statusstring

Allowed:activedeleted

Responses

200

Paginated list of wallet programs

total_itemsinteger

per_pageinteger

pageinteger

_linksHalLinks

_classstring[]

_embeddedobject

Show properties

itemsWalletProgram[]

Show properties

Array of WalletProgram

_linksHalLinks

idinteger

typestring

Allowed:pointscredit

namestring

statusstring

Allowed:activedeleted

points_namestring

Display name for points (e.g. "points", "coins").

points_mininteger

Minimum points balance required to redeem.

points_durationstring

How long earned points remain valid, e.g. "1_year".

points_dividerinteger

Amount of currency per point earned.

points_divider_scopestring

Allowed:cart_totaltotal

credits_renewalstring

Allowed:manualautomatic

credits_reserveboolean

created_onstring<date-time>

updated_onstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

seller_idquery*typequerystatusquery

Request

curl -X GET 'https://api.onbolder.com/v2/wallet_programs?seller_id=7' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/wallet_programs?seller_id=7", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/wallet_programs?seller_id=7",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "walletPrograms"
  ],
  "total_items": 1,
  "per_page": 30,
  "page": 1,
  "_links": {
    "self": {
      "href": "https://api.onbolder.com/v2/wallet_programs"
    }
  },
  "_embedded": {
    "items": [
      {
        "id": 4,
        "type": "points",
        "name": "Loyalty",
        "status": "active",
        "points_name": "points",
        "points_min": 500,
        "points_duration": "1_year",
        "points_divider": 100,
        "points_divider_scope": "cart_total",
        "_links": {
          "self": {
            "href": "https://api.onbolder.com/v2/wallet_programs/4"
          }
        }
      }
    ]
  }
}