iotoms Docs

Get store credit balance

GET
/api/v1/payments/store-credits/pending

Returns store credit issued, redeemed and still available, in total and per customer and store. Filter by customerNumber and/or storeId.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

customerNumber?string

Limit the balance to this customer account. Omit for all customers.

storeId?integer

Limit the balance to this customer store ID. Omit for all stores.

Formatint64

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

Store credit totals and a row per customer and store.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/payments/store-credits/pending'
Example Response
{  "status": "string",  "message": "string",  "data": {    "totalIssued": 0,    "totalRedeemed": 0,    "pendingAmount": 0,    "rows": [      {        "customerNumber": "string",        "storeId": 0,        "issued": 0,        "redeemed": 0,        "pending": 0      }    ]  }}