Report the terminal result

Sets the customer query to successful or failed and stores the mobile money provider’s externalId. Send the query id, your referenceId, or both when they refer to the same query. Sending the same status and provider id again returns the current record.

POST/api/v1/partners/customer-queries/status

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.

Request body

requiredapplication/json

idstring<uuid>

The customer query id.

referenceIdstring

Your reference for the query.

min length 1

externalIdstringrequired

The mobile money provider's id for this transaction.

min length 1

statusstringrequired

How the terminal transaction ended.

Allowed:successfulfailed

Responses

200

The customer query, with the terminal status applied.

dataCustomerQueryResultrequired

Show properties

idstring<uuid>required

partnerobjectrequired

Show properties

partnerIdstring<uuid>required

partnerNamestringrequired

customerobjectrequired

Show properties

firstNamestringrequired

lastNamestringrequired

tagobjectrequired

Show properties

tagIdstringrequired

tagNumberstringrequired

mobileNumbersobject[]required

Show properties

Array of object

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

400

The body did not include a query id or a referenceId.

errorstringrequired

messagestringrequired

401

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

errorstringrequired

messagestringrequired

403

This API key cannot run customer queries.

errorstringrequired

messagestringrequired

404

No customer query with those identifiers belongs to this API key.

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Bodyapplication/json

idstringThe customer query id.referenceIdstringYour reference for the query.externalIdstring*The mobile money provider's id for this transaction.statusstring*How the terminal transaction ended.

Request

curl -X POST 'https://api-uat.cards.justtap.io/api/v1/partners/customer-queries/status' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "referenceId": "string",
  "externalId": "string",
  "status": "successful"
}'

const response = await fetch("https://api-uat.cards.justtap.io/api/v1/partners/customer-queries/status", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n  \"referenceId\": \"string\",\n  \"externalId\": \"string\",\n  \"status\": \"successful\"\n}"
});

import requests

response = requests.post(
    "https://api-uat.cards.justtap.io/api/v1/partners/customer-queries/status",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n  \"referenceId\": \"string\",\n  \"externalId\": \"string\",\n  \"status\": \"successful\"\n}",
)

Response

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "partner": {
      "partnerId": "bf408d53-df49-40a6-8455-a34bd4360901",
      "partnerName": "string"
    },
    "customer": {
      "firstName": "string",
      "lastName": "string"
    },
    "tag": {
      "tagId": "string",
      "tagNumber": "string",
      "mobileNumbers": [
        {
          "operator": "airtel_money",
          "mobileNumber": "string",
          "status": "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"
  }
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "VALIDATION_ERROR",
  "message": "string",
  "errors": [
    {
      "field": "string",
      "rule": "string",
      "message": "string"
    }
  ]
}

{
  "error": "string",
  "message": "string"
}