Zid Docs

Customer Wallet

GETv1/customers/loyalty-program/<<STORE_ID>>/wallet

Retrieves detailed information about a customer's loyalty wallet, including points balance, currency type, and tier level.

Request

Query Params

STORE_ID

number

optional

Unique identifier of the store.

Header Params

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

string

optional

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Default:

application/json

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Content-Type

string

optional

Type of the content.

Default:

application/json

X-CUSTOMER-TOKEN

string

optional

The X-CUSTOMER-TOKEN is a unique identifier generated when a customer logs in through the customer-login API. This token acts as the standard authorization mechanism, allowing the system to recognize the logged-in customer and grant them access to appropriate resources.

Body Params text/plain

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

The Wallet is retrieved successfully.

status

string

optional

Indicates the overall status of the API response, encapsulating various details within the wallet and message objects.

wallet

object

optional

Contains detailed information about the user's wallet, including balances, points history, and transaction details.

points_balance

integer

optional

The current total of points available in the user's wallet.

Example:

9795

pending_points_balance

integer

optional

The total of points that are pending and not yet available for use.

available_points

integer

optional

The points that the user can immediately use.

Example:

5600

used_points

integer

optional

The points that have been used by the user.

Example:

101

total_positive_points

integer

optional

The cumulative total of positive points the user has earned over time.

Example:

history

array [object {9}]

optional

A list of past point transactions, detailing each transaction's specifics.

message

object

optional

Contains any additional information or messages related to the API response.

type

string

optional

code

null

optional

A code representing the message type or error code, if any.

name

null

optional

The name of the message or error, if available.

description

null

optional

A detailed description of the message or error, providing more context.

{
  "status": "string",
  "wallet": {
    "points_balance": 9795,
    "pending_points_balance": 0,
    "available_points": 5600,
    "used_points": 101,
    "total_positive_points": 0,
    "history": [
      {
        "date": "\"2024-07-24T07:42:12.000000Z\"",
        "reason": null,
        "points": 200,
        "direction": "\"+\"",
        "type": "\"PaymentReward\"",
        "order_number": 39001552,
        "expiry_date": "\"2025-07-19T07:42:40.028933Z\"",
        "point_status": "\"Active\"",
        "collection_method": "\"Reward for a placed order\""
      }
    ]
  },
  "message": {
    "type": "string",
    "code": null,
    "name": null,
    "description": null
  }
}

Last modified: a month ago