Link Search Menu Expand Document

Getting the “card” of a user

  • Call name: get-card
  • Endpoint URL: https://api0.spaaza.com/get-card
  • Request methods: GET
  • Response Content-Type: application/json
  • Auth required: yes

Get the entity card (loyalty memberships) and claimed vouchers (but not those validated by the shop) for a user.

Permissions and Authentication

This API call requires a valid Spaaza session. The session can be as follows:

  • User authentication: a session generated by an end-user login.
  • Admin authentication: the performing user needs to be logged in and have read access to the entity (business or chain) to which the user is connected.
  • Privileged authentication: the use of privileged authentication is permitted for this endpoint.

HTTP Parameters

The following HTTP parameters can be passed to the API:

Parameter Description
chain_id (Integer. Required with admin authentication.) The id of the chain for which the information is being requested.
user_id OR member_number OR username OR authentication_point_identifier (required with admin and privileged authentication) The id, member_number (user code), username (email address) or identity in a third-party authentication system (authentication_point_identifier) of the user for whom the card details are being requested.

Headers

The following headers can/must be passed to the API call:

Parameter Description
X-MyPrice-App-Hostname (mandatory) The hostname of the app for which the user is requesting the card.
Accept-Language (optional) A standard RFC 2616 header defining the ordered language preferences for the request. In the case that this is provided, localised versions of field names are also returned in the response where these are defined. The presence of localised fields is dynamic. If they are not defined in the field_localisations field for the specific object, then localised fields are not returned.

Permissions

This API call requires no specific permissions other than to view entity card and vouchers associated with the user’s own account.

Results

The result output is a JSON array with its results section being similar to the following:

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "entity": {
            "id": 1743,
            "name": "Acme Inc",
            "type": "chain",
            "email_address": "info@acme.com",
            "phone_number": null,
            "currency": {
                "currency_id": 2,
                "currency_code": "EUR",
                "currency_name_en": "Euro",
                "currency_symbol": "€"
            },
            "var_price_permitted": true,
            "var_price_round_up": false,
            "var_price_custom_entity_code": true,
            "var_price_custom_age_string": null,
            "deleted": false,
            "calculate_basket_on_total_value_online": true,
            "calculate_basket_on_total_value_in_store": true,
            "basket_voucher_always_redeem_full_value_online": false,
            "return_redeem_voucher_before_cash": false,
            "basket_voucher_always_redeem_full_value_in_store": false,
            "receipts_service_active": true,
            "redeem_basket_voucher_on_negative_value_basket": false,
            "regenerated_rewards_redeem_immediately": false,
            "expired_vouchers_regenerate_on_return": false,
            "language": null,
            "image_filename": null,
            "image_url": "https://s3.eu-west-1.amazonaws.com/chain-images-test01.spaaza.com/logo-1743.jpg",
            "receipt_logo_filename": null,
            "receipt_logo_url": null
        },
        "entity_images": {},
        "card_colour": null,
        "user_info": {
            "id": 3635922,
            "user_id": 3635922,
            "first_name": "John",
            "last_name": "Smith",
            "country_code": "NL",
            "gender": "M",
            "signup_channel": "webshop",
            "username": "john.smith@example.com",
            "authentication_point_identifier": "20091501",
            "auxiliary_identifier": null,
            "mailing_list": {
                "mailing_list_sub_offered": false,
                "mailing_list_subscribed": false,
                "printed_mailing_list_subscribed": false
            },
            "entity_code": {
                "type": "custom",
                "code": "500056883"
            },
            "opt_in_programme": {
                "programme_opted_in": true,
                "join_date": "2020-04-21T13:44:43+00:00"
            },
            "obfuscated": false,
            "is_influencer": false,
            "address_streetname": null,
            "address_housenumber": null,
            "address_housenumber_extension": null,
            "address_line_2": null,
            "address_line_3": null,
            "address_towncity": null,
            "address_regionstate": null,
            "address_postalcode": null,
            "member_number": "500056883",
            "language": "en-GB",
            "opt_in_secondary": null,
            "registered": true,
            "is_employee": false,
            "push_notification_subscription": {
                "subscribed": false,
                "subscriptions": []
            },
            "loyalty_status": {
                "campaign_id": 159,
                "name": "Gold",
                "description": "Level 3 in Acme Programme",
                "loyalty_level_id": 8,
                "points_balance_current": 1001,
                "monetary_balance_current": null,
                "points_to_proceed_next_level": null,
                "points_to_remain_current_level": 0,
                "last_review_date": "2020-04-21T13:44:43+00:00",
                "next_review_date": null,
                "date_reached": "2020-04-21T13:51:25+00:00"
            },
            "frequency": 0,
            "recency": 0,
            "monetary": 0,
            "overall": 0,
            "stores": "",
            "online_shopper": false,
            "offline_shopper": false,
            "average_basket_value": "0.00",
            "days_since_last_purchase": null,
            "number_of_purchases": 0,
            "referring_user": null,
            "referral_code": "7rzblh"
        },
        "user_entity_card": {
            "type": "custom",
            "code": "500056883"
        },
        "vouchers": [],
        "meta_vouchers": [],
        "basket_vouchers": [
            {
                "voucher_key": "b8c9f4635a601c0c242a677709341d4d707de66c63d8d8b0ba4a577f63c41465",
                "voucher_id": 325814,
                "voucher_created_datetime": "2020-04-21T13:44:44+00:00",
                "voucher_type": "basket",
                "voucher_status": "generated",
                "voucher_locked": false,
                "campaign_id": 219,
                "campaign_type": "signup",
                "campaign_title": "Welcome to Acme",
                "campaign_image_filename": null,
                "campaign_image_url": null,
                "campaign_image_link": null,
                "campaign_image_dimension_x": null,
                "campaign_image_dimension_y": null,
                "voucher_expiry_datetime_utc": "2053-02-27 13:44:44",
                "voucher_expiry_seconds_remaining": 998789778,
                "voucher_redeemed_datetime": null,
                "generating_return_transaction": [],
                "parent_voucher": null,
                "voucher_title": "Welcome to Acme Club!",
                "voucher_text": "Signup voucher",
                "voucher_description": "undefined",
                "voucher_notes": "undefined",
                "voucher_honour_code": null,
                "voucher_image_url": null,
                "voucher_discount_ratio": 0,
                "voucher_currency_id": 2,
                "voucher_currency_symbol": "€",
                "voucher_amount_original": 10,
                "voucher_amount_redeemed": 0,
                "voucher_amount": 10,
                "redeeming_basket": []
            },
            {
                "voucher_key": "f9f25bea99cf43965c342d7b790626921925cca84b5072c953ba8e6c006d662a",
                "voucher_id": 325816,
                "voucher_created_datetime": "2020-04-21T13:51:25+00:00",
                "voucher_type": "basket",
                "voucher_status": "generated",
                "voucher_locked": false,
                "campaign_id": 159,
                "campaign_type": "loyalty",
                "campaign_title": "Acme Loyalty Campaign",
                "campaign_image_filename": null,
                "campaign_image_url": null,
                "campaign_image_link": null,
                "campaign_image_dimension_x": null,
                "campaign_image_dimension_y": null,
                "voucher_expiry_datetime_utc": "2050-01-01 00:00:00",
                "voucher_expiry_seconds_remaining": 899121094,
                "loyalty_rule": {
                    "loyalty_rule_id": 9,
                    "loyalty_rule_type": "points_tracker"
                },
                "voucher_redeemed_datetime": null,
                "generating_return_transaction": [],
                "parent_voucher": null,
                "voucher_title": null,
                "voucher_text": "Your Acme loyalty voucher",
                "voucher_description": null,
                "voucher_notes": null,
                "voucher_honour_code": null,
                "voucher_image_url": null,
                "voucher_discount_ratio": 0,
                "voucher_currency_id": 2,
                "voucher_currency_symbol": "€",
                "voucher_amount_original": 25,
                "voucher_amount_redeemed": 0,
                "voucher_amount": 25,
                "redeeming_basket": []
            },
            {
                "voucher_key": "02a0408e3870cd2b5db00830803969e36101a6f48d94800d800538991fd15803",
                "voucher_id": 325817,
                "voucher_created_datetime": "2020-04-21T13:51:25+00:00",
                "voucher_type": "basket",
                "voucher_status": "generated",
                "voucher_locked": false,
                "campaign_id": 159,
                "campaign_type": "loyalty",
                "campaign_title": "Acme Loyalty Campaign",
                "campaign_image_filename": null,
                "campaign_image_url": null,
                "campaign_image_link": null,
                "campaign_image_dimension_x": null,
                "campaign_image_dimension_y": null,
                "voucher_expiry_datetime_utc": "2050-01-01 00:00:00",
                "voucher_expiry_seconds_remaining": 899121094,
                "loyalty_rule": {
                    "loyalty_rule_id": 14,
                    "loyalty_rule_type": "points_tracker"
                },
                "voucher_redeemed_datetime": null,
                "generating_return_transaction": [],
                "parent_voucher": null,
                "voucher_title": null,
                "voucher_text": "Your Acme loyalty voucher",
                "voucher_description": null,
                "voucher_notes": null,
                "voucher_honour_code": null,
                "voucher_image_url": null,
                "voucher_discount_ratio": 0,
                "voucher_currency_id": 2,
                "voucher_currency_symbol": "€",
                "voucher_amount_original": 25,
                "voucher_amount_redeemed": 0,
                "voucher_amount": 25,
                "redeeming_basket": []
            },
            {
                "voucher_key": "2dfec51a28e7d2cb48caa42c6d8806acdae7ff2a68e5dc79514d8539578d7d82",
                "voucher_id": 325818,
                "voucher_created_datetime": "2020-04-21T13:51:25+00:00",
                "voucher_type": "basket",
                "voucher_status": "generated",
                "voucher_locked": false,
                "campaign_id": 159,
                "campaign_type": "loyalty",
                "campaign_title": "Acme Loyalty Campaign",
                "campaign_image_filename": null,
                "campaign_image_url": null,
                "campaign_image_link": null,
                "campaign_image_dimension_x": null,
                "campaign_image_dimension_y": null,
                "voucher_expiry_datetime_utc": "2050-01-01 00:00:00",
                "voucher_expiry_seconds_remaining": 899121094,
                "loyalty_rule": {
                    "loyalty_rule_id": 15,
                    "loyalty_rule_type": "points_tracker"
                },
                "voucher_redeemed_datetime": null,
                "generating_return_transaction": [],
                "parent_voucher": null,
                "voucher_title": null,
                "voucher_text": "Your Acme loyalty voucher",
                "voucher_description": null,
                "voucher_notes": null,
                "voucher_honour_code": null,
                "voucher_image_url": null,
                "voucher_discount_ratio": 0,
                "voucher_currency_id": 2,
                "voucher_currency_symbol": "€",
                "voucher_amount_original": 50,
                "voucher_amount_redeemed": 0,
                "voucher_amount": 50,
                "redeeming_basket": []
            }
        ],
        "honour_vouchers": [],
        "promotions": {
            "cashback": [
                {
                    "type": "cashback",
                    "campaign_id": 1301,
                    "title": "Earn double in store",
                    "description": "",
                    "progress": null,
                    "supports_contribution": true,
                    "is_contributor": true,
                    "recipient_campaign_id": 157,
                    "image_url": null,
                    "image_link": null,
                    "actions": [],
                    "currency_id": 2,
                    "currency": "EUR",
                    "currency_symbol": "€",
                    "recipient_reward_method": "points",
                    "recipient_reward_amount": 1,
                    "saved_amount": 0,
                    "earn_percentage": 100
                },
                {
                    "type": "cashback",
                    "campaign_id": 158,
                    "title": "Earn points on every purchase",
                    "description": "Get 1 point for each €1 spent",
                    "progress": null,
                    "supports_contribution": true,
                    "is_contributor": true,
                    "recipient_campaign_id": 157,
                    "image_url": "https://s3.eu-west-1.amazonaws.com/campaign-images-test01.spaaza.com/897/3.png",
                    "image_link": null,
                    "actions": [],
                    "currency_id": 5,
                    "currency": "PTS",
                    "currency_symbol": "pts",
                    "recipient_reward_method": "points",
                    "recipient_reward_amount": 1,
                    "saved_amount": 0,
                    "earn_percentage": 100
                }
            ],
            "interaction": [
                {
                    "type": "interaction",
                    "campaign_id": 1193,
                    "title": "Plant a tree for 100 points",
                    "description": "Convert your points into a tree that we'll plant on your behalf",
                    "progress": null,
                    "supports_contribution": true,
                    "is_contributor": false,
                    "recipient_campaign_id": null,
                    "image_url": "https://s3.eu-west-1.amazonaws.com/campaign-images-test01.spaaza.com/1193/tree-image.jpg",
                    "image_link": null,
                    "actions": [],
                    "currency_id": 2,
                    "currency": "EUR",
                    "currency_symbol": "€",
                    "recipient_reward_method": "voucher",
                    "recipient_reward_code": "tree100",
                    "redeemed": false,
                    "point_cost": 100
                }
            ],
            "mobile_content": [
                {
                    "type": "mobile_content",
                    "campaign_id": 1134,
                    "title": "New York",
                    "description": "",
                    "progress": null,
                    "supports_contribution": false,
                    "is_contributor": false,
                    "recipient_campaign_id": null,
                    "image_url": "https://s3.eu-west-1.amazonaws.com/campaign-images-test01.spaaza.com/895/2.png",
                    "image_link": null,
                    "actions": [],
                    "currency_id": 2,
                    "currency": "EUR",
                    "currency_symbol": "€"
                },
                {
                    "type": "mobile_content",
                    "campaign_id": 1133,
                    "title": "Shoes collection",
                    "description": "",
                    "progress": null,
                    "supports_contribution": false,
                    "is_contributor": false,
                    "recipient_campaign_id": null,
                    "image_url": "https://s3.eu-west-1.amazonaws.com/campaign-images-test01.spaaza.com/896/1.png",
                    "image_link": null,
                    "actions": [],
                    "currency_id": 2,
                    "currency": "EUR",
                    "currency_symbol": "€"
                }
            ],
            "referral": [
                {
                    "type": "referral",
                    "campaign_id": 703,
                    "title": "Invite Friends!",
                    "description": "Invite friends and you will both earn rewards.",
                    "progress": null,
                    "supports_contribution": false,
                    "is_contributor": false,
                    "recipient_campaign_id": null,
                    "image_url": "https://s3.eu-west-1.amazonaws.com/campaign-images-test01.spaaza.com/703/silhouette-photography-of-group-of-people-jumping-during-1000445.jpg",
                    "image_link": null,
                    "actions": [],
                    "currency_id": 2,
                    "currency": "EUR",
                    "currency_symbol": "€",
                    "recipient_reward_method": "percentage_basket_voucher",
                    "recipient_reward_discount_ratio": 0.1,
                    "recipient_message_text": "10% voucher",
                    "sender_reward_method": "percentage_basket_voucher",
                    "sender_reward_discount_ratio": 0.1,
                    "sender_message_text": "10% voucher for referring a customer",
                    "code": "7rzblh"
                }
            ],
            "basket": [
                {
                    "id": 236,
                    "chain_id": 1743,
                    "title": "Gold 10% off",
                    "description": "Gold Level  members get 10% off",
                    "active": true,
                    "operator_type": "or",
                    "created_date": "2018-07-04T09:12:38+00:00",
                    "last_modified_date": "2021-04-19T08:07:59+00:00",
                    "user_segment_id": "AWNkG0vgpp3ErSgjijjG",
                    "rounding_strategy": "neutral",
                    "rounding_precision": 2,
                    "created_voucher_claimed_by_default": true,
                    "excludes_assignment_matches": true,
                    "base_price_threshold": "0.9000",
                    "spend_on_promotional_items": true,
                    "allows_unrecognised_items": true,
                    "is_active": true,
                    "is_deleted": false,
                    "is_default": false,
                    "excludes_referred_users": false,
                    "visible_to_all_user_segments": false,
                    "type": "basket",
                    "minimum_basket_total_value": 0,
                    "last_updated_date": "2021-04-19T08:07:59+00:00",
                    "last_updated_by": {
                        "user_id": 1,
                        "name": "Sam Critchley"
                    },
                    "field_localisations": null,
                    "rules": [],
                    "assignment_count": 177,
                    "assignment_count_by_type": {
                        "product": 0,
                        "category": 0,
                        "brand": 0,
                        "season": 0,
                        "gender": 0,
                        "barcode": 177,
                        "business": 0,
                        "currency": 0
                    },
                    "assigned_products": [],
                    "assigned_categories": [],
                    "assigned_brands": [],
                    "assigned_seasons": [],
                    "assigned_genders": [],
                    "assigned_barcodes": [
                        "452500_000_0230_S",
                        "452001_000_0230_M",
                        "452001_000_0802_3XL",
                        "451000_000_0230_S",
                        "450102_000_C002_L",
                        "452500_000_0101_M"
                    ],
                    "assigned_business_ids": [],
                    "assigned_currencies": [],
                    "parameters": [],
                    "image_filename": null,
                    "image_url": null,
                    "image_link": null,
                    "image_dimension_x": null,
                    "image_dimension_y": null,
                    "supports_contribution": true,
                    "is_contributor": false,
                    "recipient_campaign_id": null,
                    "supports_user_segments": true,
                    "excluded_user_segment_id": null,
                    "secondary_display_currency": null,
                    "secondary_display_currency_symbol": null,
                    "secondary_display_multiplication_factor": null,
                    "secondary_display_rounding_precision": null,
                    "voucher_title": null,
                    "voucher_description": null,
                    "voucher_notes": null,
                    "voucher_text": null,
                    "voucher_image_url": null
                }
            ],
            "signup": [
                {
                    "type": "signup",
                    "campaign_id": 219,
                    "title": "Welcome to Acme",
                    "description": "€10 for signing up for the program.",
                    "progress": null,
                    "supports_contribution": true,
                    "is_contributor": false,
                    "recipient_campaign_id": null,
                    "image_url": null,
                    "image_link": null,
                    "actions": [],
                    "currency_id": 2,
                    "currency": "EUR",
                    "currency_symbol": "€",
                    "recipient_reward_method": "voucher",
                    "recipient_reward_amount": 10
                }
            ],
            "loyalty": [
                {
                    "id": 159,
                    "chain_id": 1743,
                    "title": "Acme Loyalty Campaign",
                    "description": "The best loyalty programme",
                    "active": true,
                    "created_date": "2017-09-22T08:49:22+00:00",
                    "last_modified_date": "2017-09-22T08:49:22+00:00",
                    "created_voucher_claimed_by_default": false,
                    "excludes_assignment_matches": false,
                    "currency_id": 2,
                    "voucher_text": "Your Acme loyalty voucher",
                    "myprice_app_id": 16,
                    "loyalty_rules": [
                        {
                            "id": 7,
                            "campaign_id": 159,
                            "title": "Set level rule for joining Acme Loyalty Programme",
                            "loyalty_level_id": 1,
                            "action": "setLevel",
                            "points_threshold": 0,
                            "action_is_repeatable": false,
                            "type": "initial",
                            "loyalty_level_name": "Blue"
                        },
                        {
                            "id": 8,
                            "campaign_id": 159,
                            "title": "Rule for levelling up to Bronze in the Acme Loyalty Programme",
                            "loyalty_level_id": 2,
                            "action": "setLevel",
                            "direction": "up",
                            "points_threshold": 250,
                            "action_is_repeatable": false,
                            "operand_campaign_id": 157,
                            "wallet_campaign_id": 157,
                            "type": "points_tracker",
                            "loyalty_level_name": "Bronze"
                        },
                        {
                            "id": 9,
                            "campaign_id": 159,
                            "title": "Rule for creating a basket voucher when members reach Bronze status",
                            "action": "createBasketVoucher",
                            "direction": "up",
                            "points_threshold": 250,
                            "action_amount": 25,
                            "action_is_repeatable": false,
                            "operand_campaign_id": 159,
                            "wallet_campaign_id": 157,
                            "type": "points_tracker",
                            "action_expiry_unit": null,
                            "action_expiry_quantity": null
                        },
                        {
                            "id": 10,
                            "campaign_id": 159,
                            "title": "Rule for levelling up to Silver in the Acme Loyalty Programme",
                            "loyalty_level_id": 3,
                            "action": "setLevel",
                            "direction": "up",
                            "points_threshold": 500,
                            "action_is_repeatable": false,
                            "operand_campaign_id": 157,
                            "wallet_campaign_id": 157,
                            "type": "points_tracker",
                            "loyalty_level_name": "Silver"
                        },
                        {
                            "id": 13,
                            "campaign_id": 159,
                            "title": "Rule for levelling up to Gold in the Acme Loyalty Programme",
                            "loyalty_level_id": 8,
                            "action": "setLevel",
                            "direction": "up",
                            "points_threshold": 1000,
                            "action_is_repeatable": false,
                            "operand_campaign_id": 157,
                            "wallet_campaign_id": 157,
                            "type": "points_tracker",
                            "loyalty_level_name": "Gold"
                        },
                        {
                            "id": 14,
                            "campaign_id": 159,
                            "title": "Rule for creating a basket voucher when members reach Silver status",
                            "action": "createBasketVoucher",
                            "direction": "up",
                            "points_threshold": 500,
                            "action_amount": 25,
                            "action_is_repeatable": false,
                            "operand_campaign_id": 159,
                            "wallet_campaign_id": 157,
                            "type": "points_tracker",
                            "action_expiry_unit": null,
                            "action_expiry_quantity": null
                        },
                        {
                            "id": 15,
                            "campaign_id": 159,
                            "title": "Rule for creating a basket voucher when members reach Gold status",
                            "action": "createBasketVoucher",
                            "direction": "up",
                            "points_threshold": 1000,
                            "action_amount": 50,
                            "action_is_repeatable": false,
                            "operand_campaign_id": 159,
                            "wallet_campaign_id": 157,
                            "type": "points_tracker",
                            "action_expiry_unit": null,
                            "action_expiry_quantity": null
                        }
                    ],
                    "loyalty_levels": [
                        {
                            "id": 1,
                            "campaign_id": 159,
                            "name": "Blue",
                            "description": "Initial level in Acme Programme",
                            "automated_level_logic": true
                        },
                        {
                            "id": 2,
                            "campaign_id": 159,
                            "name": "Bronze",
                            "description": "Level 1 in Acme Programme",
                            "automated_level_logic": true
                        },
                        {
                            "id": 3,
                            "campaign_id": 159,
                            "name": "Silver",
                            "description": "Level 2 in Acme Programme",
                            "automated_level_logic": true
                        },
                        {
                            "id": 5,
                            "campaign_id": 159,
                            "name": "Platinum",
                            "description": "Level 4 (VIP) in Acme Programme",
                            "automated_level_logic": false
                        },
                        {
                            "id": 8,
                            "campaign_id": 159,
                            "name": "Gold",
                            "description": "Level 3 in Acme Programme",
                            "automated_level_logic": true
                        },
                        {
                            "id": 29,
                            "campaign_id": 159,
                            "name": "Employee",
                            "description": "Employee of Acme",
                            "automated_level_logic": true
                        }
                    ],
                    "is_active": true,
                    "is_deleted": false,
                    "is_default": false,
                    "excludes_referred_users": false,
                    "visible_to_all_user_segments": true,
                    "type": "loyalty",
                    "minimum_basket_total_value": 0,
                    "last_updated_date": null,
                    "field_localisations": null,
                    "assignment_count": 0,
                    "image_filename": null,
                    "image_url": null,
                    "image_link": null,
                    "image_dimension_x": null,
                    "image_dimension_y": null,
                    "recipient_campaign_id": null,
                    "supports_user_segments": false,
                    "user_segment_id": null,
                    "excluded_user_segment_id": null,
                    "secondary_display_currency": null,
                    "secondary_display_currency_symbol": null,
                    "secondary_display_multiplication_factor": null,
                    "secondary_display_rounding_precision": null,
                    "voucher_title": null,
                    "voucher_description": null,
                    "voucher_notes": null,
                    "voucher_image_url": null
                }
            ],
            "wallets": {
                "points": [
                    {
                        "id": 157,
                        "chain_id": 1743,
                        "title": "Acme Points Wallet",
                        "description": "Build up points in your wallet",
                        "active": true,
                        "operator_type": "or",
                        "created_date": "2017-09-22T08:41:20+00:00",
                        "last_modified_date": "2017-09-22T08:41:20+00:00",
                        "rounding_strategy": "round_up",
                        "rounding_precision": 0,
                        "created_voucher_claimed_by_default": false,
                        "voucher_expiry_days": 0,
                        "excludes_assignment_matches": false,
                        "currency_id": 5,
                        "is_redeemable": false,
                        "balance_can_subzero": true,
                        "spend_on_promotional_items": true,
                        "max_manual_daily_amount": "11000.00",
                        "is_active": true,
                        "is_deleted": false,
                        "is_default": true,
                        "excludes_referred_users": false,
                        "visible_to_all_user_segments": true,
                        "type": "points_wallet",
                        "minimum_basket_total_value": 0,
                        "last_updated_date": null,
                        "field_localisations": null,
                        "assignment_count": 0,
                        "parameters": [],
                        "image_filename": null,
                        "image_url": null,
                        "image_link": null,
                        "image_dimension_x": null,
                        "image_dimension_y": null,
                        "secondary_display_currency": null,
                        "secondary_display_currency_symbol": null,
                        "secondary_display_multiplication_factor": null,
                        "secondary_display_rounding_precision": null,
                        "voucher_title": null,
                        "voucher_description": null,
                        "voucher_notes": null,
                        "voucher_text": null,
                        "voucher_image_url": null,
                        "saved_amount": 1001,
                        "total_amount": 1001,
                        "currency": "PTS",
                        "currency_symbol": "pts"
                    }
                ]
            }
        },
        "notes": [],
        "points": {
            "id": 157,
            "chain_id": 1743,
            "title": "Acme Points Wallet",
            "description": "Build up points in your wallet",
            "active": true,
            "operator_type": "or",
            "created_date": "2017-09-22T08:41:20+00:00",
            "last_modified_date": "2017-09-22T08:41:20+00:00",
            "rounding_strategy": "round_up",
            "rounding_precision": 0,
            "created_voucher_claimed_by_default": false,
            "voucher_expiry_days": 0,
            "excludes_assignment_matches": false,
            "currency_id": 5,
            "is_redeemable": false,
            "balance_can_subzero": true,
            "spend_on_promotional_items": true,
            "max_manual_daily_amount": "11000.00",
            "is_active": true,
            "is_deleted": false,
            "is_default": true,
            "excludes_referred_users": false,
            "visible_to_all_user_segments": true,
            "type": "points_wallet",
            "minimum_basket_total_value": 0,
            "last_updated_date": null,
            "field_localisations": null,
            "assignment_count": 0,
            "parameters": [],
            "image_filename": null,
            "image_url": null,
            "image_link": null,
            "image_dimension_x": null,
            "image_dimension_y": null,
            "secondary_display_currency": null,
            "secondary_display_currency_symbol": null,
            "secondary_display_multiplication_factor": null,
            "secondary_display_rounding_precision": null,
            "voucher_title": null,
            "voucher_description": null,
            "voucher_notes": null,
            "voucher_text": null,
            "voucher_image_url": null,
            "saved_amount": 1001,
            "total_amount": 1001,
            "currency": "PTS",
            "currency_symbol": "pts"
        },
        "loyalty_status": {
            "campaign_id": 159,
            "name": "Gold",
            "description": "Level 3 in Acme Programme",
            "loyalty_level_id": 8,
            "points_balance_current": 1001,
            "monetary_balance_current": null,
            "points_to_proceed_next_level": null,
            "points_to_remain_current_level": 0,
            "last_review_date": "2020-04-21T13:44:43+00:00",
            "next_review_date": null,
            "date_reached": "2020-04-21T13:51:25+00:00"
        },
        "wallet": null,
        "result_type": "get-user-entity-card"
    }
}

Possible error responses

The following represents a list of possible error responses for the get-card endpoint:

Code Name and Description HTTP Status Code
1 username_invalid
The username is incorrectly formatted. Your username should be a valid email address.
400
6 no_valid_session
The user needs to be logged in and a valid session key needs to be sent
401
68 permission_denied_or_non_existent
This user has insufficient permissions for this object or the object does not exist.
500
144 business_id_not_found
No record has been found for that business_id
500
149 fb_access_token_invalid
The fb_access_token passed must be alphanumeric and between 1 and 2048 characters long.
500
154 user_id_invalid
The user_id passed must be an integer up to 10 digits long
400
217 chain_id_not_found
No record has been found for that chain_id
400
228 auth_method_invalid
The given auth_method parameter has an invalid value.
500
264 myprice_app_without_entity
The requested MyPrice app does not have an entity associated with it.
400
265 authorization_invalid
The given authorization header is invalid.
400
267 no_valid_user
A valid username needs to be specified
401
269 no_myprice_app
Myprice app is required
400
270 user_not_found
No user was found
404
416 multiple_parameter_mismatch
Multiple parameters supplied when fewer are required
400
424 access_denied
Access is denied
400