Get Card Inquiry

get/api/inquiries/{inquiryId}

Retrieves a specific inquiry for the given id.

Inquiries are used to perform pre-payment checks. Depending on the type, the inquiries purpose can be to validate there are no active blocks on a card or cardholder, or to check their available balance.

Request

Path Parameters

inquiryIdstringrequired
Primary identifier of the inquiry to fetch

Response

Successful operation.

Body application/json

idstringrequired
Inquiry identifier.
typestringrequired
The type of inquiry.
This set is non-exhaustive and may grow over time, so consumers should tolerate unrecognised values. The current values are account-status-inquiry and balance-inquiry.
Balance inquiries are not currently supported and are always declined with the result code transaction-not-permitted-to-cardholder.
livenessstringrequired
Allowed values:livetest
The resource liveness mode.
declineReasonstring
Reason the inquiry was declined only if applicable.
resultobject
Outcome of the inquiry. Present once a result has been recorded.
- acceptedbooleanrequired
  Indicates whether the inquiry was accepted.
- codestringrequired
  The result code for the inquiry.
- messagestring
  A human-readable description of the result.
merchantobject
Merchant descriptor. Present when the underlying network message carries merchant details.
- idstring
  The merchant identifier from the payment network.
- namestring
  The merchant's name.
- terminalIdstring
  The merchant's payment terminal identifier.
- categoryCodestring
  The merchant's ISO-18245 category code.
- citystring
  The merchant's city name.
- countryCodestring
  The merchant's ISO-3166-1 Alpha-2 country code.
cardobjectrequired
The card the inquiry relates to.
- idstringrequired
  Card identifier.
cardholderobjectrequired
The cardholder the inquiry relates to.
- idstringrequired
  Cardholder account identifier.
createdAtstring<date-time>required
ISO 8601 timestamp of when the inquiry was recorded.
modifiedAtstring<date-time>required
ISO 8601 timestamp of when the inquiry was last modified.

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/inquiries/{inquiryId}' \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "id": "1993e3250d12948cf2bd1a1964f69437",
  "type": "account-status-inquiry",
  "liveness": "test",
  "declineReason": "inactive-card",
  "result": {
    "accepted": true,
    "code": "success",
    "message": "string"
  },
  "merchant": {
    "id": "123456789012345",
    "name": "1 Queen Street",
    "terminalId": "12345678",
    "categoryCode": "1234",
    "city": "Auckland",
    "countryCode": "NZ"
  },
  "card": {
    "id": "d44d045826d4484c9b7f1e3a5c8d2f6b"
  },
  "cardholder": {
    "id": "9ce69d31277108d46d2cb19fa772705e"
  },
  "createdAt": "2026-06-10T04:02:51.892Z",
  "modifiedAt": "2026-06-10T04:02:51.892Z"
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}