Show Loyalty Program

get https://api.hips.com/v2/loyalty/{id}

Show a loyalty program including program wallet balance. Authentication Key Type: SalesChannelApiKey

Example response

{
    "id": "iqo6aQU7jM2ZHuMg1MGDLq4H",
    "object_name": "loyalty_program",
    "name": "OXOX BONUS",
    "token_name": "credits",
    "status": "submitted",
    "base_currency": "EUR",
    "token_purchase_value_in_currency": 100,
    "token_earn_value_in_currency": 100,
    "token_topup_value_in_currency": 100,
    "start_tokens": 10,
    "public_visible": true,
    "webhook_url": "https://mywebsite.io/webhook",
    "convertion_text": "1 credit = EUR €1.00",
    "funding_e_wallet": {
        "id": "iCgjo4LJPHg7ApkArTgWKsZH",
        "object_name": "e_wallet",
        "balance": -16
    },
    "sales_e_wallet": {
        "id": "cEzp23ECf3iLZnnWw5hGzoXA",
        "object_name": "e_wallet",
        "balance": 166
    },
    "fees_e_wallet": {
        "id": "eF4d5wEDuqoPeXH3PUUdbiAL",
        "object_name": "e_wallet",
        "balance": 0
    }
}

Responses

`SalesChannelApiKey`

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.hips.com/v2/loyalty/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Example response

200Show a loyalty program including program wallet balance. Authentication Key Type: SalesChannelApiKey

404Program ID not found

`SalesChannelApiKey`