Immersve Docs
GithubX

List Card Inquiries

get/api/accounts/{cardholderAccountId}/inquiries

Lists inquiries recorded against a cardholder account, most recent first. Supports an optional inclusive createdAt date range.

This endpoint uses cursor-based pagination. Start by making a request without a cursor to get the first page. Use the nextCursor from the pageInfo in the response as the cursor for subsequent requests to retrieve further pages. Continue until nextCursor is undefined, indicating no more data.

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

  • cardholderAccountIdstringrequired

    Identifier of the cardholder account.

Query Parameters

  • limitnumber

    Amount of records to return (max 100).

  • cursorstring

    Cursor to retrieve the next page.

  • createdFromstring

    Filter for inquiries from this date (inclusive). Value should be an ISO 8601 string.

  • createdTostring

    Filter for inquiries up to this date (inclusive). Value should be an ISO 8601 string, and must be later than createdFrom.

Response

Successful operation.

Body application/json

  • itemsobject[]

    Items

    • 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.

  • pageInfoobject

    Page info for paginated results, undefined if no page info

    • nextCursorstring

      Cursor for next page, undefined if no more pages