Welcome to the Consumer Data Right Support Portal

Check out our guides, browse through our FAQs, and post your own questions for Support.

New to the Consumer Data Right? Learn more

Response when text filter not implemented Follow

Avatar
Neale Morison
  • Created:
  • Last edited:
  • Updated

Question

In a call to the Get Transactions for Account API, how should the Data Holder (DH) respond if the optional text parameter filter field is provided, but the text filter is not implemented?

Answer

The DH responds with the isQueryParamUnsupported in the meta object as part of the ResponseBankingTransactionList response. The DH returns the full unfiltered result set in the data object.

For example, a generic response would be:


{
  "data": {
    "transactions": [
      {
        "accountId": "string",
        "transactionId": "string",
        "isDetailAvailable": true,
        "type": "DIRECT_DEBIT",
        "status": "PENDING",
        "description": "string",
        "postingDateTime": "string",
        "valueDateTime": "string",
        "executionDateTime": "string",
        "amount": "string",
        "currency": "string",
        "reference": "string",
        "merchantName": "string",
        "merchantCategoryCode": "string",
        "billerCode": "string",
        "billerName": "string",
        "crn": "string",
        "apcaNumber": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0,
    "isQueryParamUnsupported": true
  }
}

 

Comments

3 comments

Sort by Date Votes
  • Avatar
    Jakub Vozarik

    Hi Neale Morison / Mark Verstege - just a quick follow-up. Is the expectation that a DH will respond with isQueryParamUnsupported regardless of whether or not the text header is included in the request or should they only include it in their response when the request contains the header and the text search is not supported and not in any other cases?

    Thanks

    1
    Comment actions Permalink
  • Avatar
    Nils Berge

    Hi Jakub Vozarik

    I'll respond to your query on ticket #1983.

    1
    Comment actions Permalink
  • Avatar
    Jarryd

    Hi Jakub Vozarik,

    The answer from the DSB Team:

    If text filtering is not supported, the expectation is that the isQueryParamUnsupported field is always present in the meta object with a value of true.
     
    If text filtering is supported, it is never required.

    Thanks,

    0
    Comment actions Permalink

Please sign in to leave a comment.