Skip to content
Just-tap Partner API
Esc
↑↓navigate↵open⌘Jpreview

List customer queries

Returns the customer queries submitted with this API key, one page at a time.

GET/api/v1/partners/customer-queries
Authorization
x-api-keyAPI key · headerrequired

API key issued by Just-tap. It identifies your organization. Do not send a partner id in the body.

Query parameters
pageinteger

Which page to return. Starts at 1.

min 1
perPageinteger

How many queries to return. Defaults to 25. Maximum 100.

min 1 · max 100
Responses
200

Customer queries for your API key.

dataCustomerQueryListItem[]required
Show properties
Array of CustomerQueryListItem
idstring<uuid>required
partnerobjectrequired
Show properties
partnerIdstring<uuid>required
partnerNamestringrequired
customerobjectrequired
Show properties
tagIdstringrequired
mobileNumberstringrequired
tagobjectrequired
Show properties
tagIdstringrequired
operatorstringrequired
Allowed:airtel_moneymtn_mobile_moneyzamtel_kwacha
mobileNumberstringrequired
statusstringrequired
transactionobjectrequired
Show properties
merchantIdstringrequired
merchantNamestringrequired
terminalIdstringrequired
referenceIdstringrequired
externalIdstring | nullrequired
currencystringrequired
amountnumberrequired
serviceChargenumberrequired

Service charge of 1 kwacha.

totalAmountnumberrequired

Amount plus the service charge.

statusstringrequired

pending until you report the terminal result.

Allowed:pendingsuccessfulfailed
createdAtstring<date-time>required
updatedAtstring<date-time>required
metadataobjectrequired
Show properties
totalintegerrequired
perPageintegerrequired
currentPageintegerrequired
lastPageintegerrequired
firstPageintegerrequired
firstPageUrlstringrequired
lastPageUrlstringrequired
nextPageUrlstring | nullrequired
previousPageUrlstring | nullrequired
401

The API key is missing, invalid, revoked, or expired.

errorstringrequired
messagestringrequired
403

This API key cannot run customer queries.

errorstringrequired
messagestringrequired
422

The request failed validation.

errorstringrequired
Allowed:VALIDATION_ERROR
messagestringrequired
errorsobject[]required
Show properties
Array of object
fieldstringrequired
rulestringrequired
messagestringrequired
500

Something went wrong on our side.

errorstringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api-uat.cards.justtap.io/api/v1/partners/customer-queries' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "partner": {
        "partnerId": "bf408d53-df49-40a6-8455-a34bd4360901",
        "partnerName": "string"
      },
      "customer": {
        "tagId": "string",
        "mobileNumber": "string"
      },
      "tag": {
        "tagId": "string",
        "operator": "airtel_money",
        "mobileNumber": "string",
        "status": "string"
      },
      "transaction": {
        "merchantId": "string",
        "merchantName": "string",
        "terminalId": "string",
        "referenceId": "string",
        "externalId": "string",
        "currency": "string",
        "amount": 0,
        "serviceCharge": 0,
        "totalAmount": 0,
        "status": "pending"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "metadata": {
    "total": 0,
    "perPage": 0,
    "currentPage": 0,
    "lastPage": 0,
    "firstPage": 0,
    "firstPageUrl": "string",
    "lastPageUrl": "string",
    "nextPageUrl": "string",
    "previousPageUrl": "string"
  }
}

Was this page helpful?