---
title: Chargeback Search
slug: public-apis/chargeback-search
createdAt: 2026-03-13T14:01:42.306Z
---

{
  "id": "RF9ytVhytMk9Eu-8bR7MN",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://api.accertify.net/api/cbv1/search",
    "name": "Chargeback Search",
    "description": "A record is looked up and a set of values returned.\n",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "search",
          "type": "object",
          "example": "{\"CaseInitStartDate\":\"2022-09-28\",\"CaseInitEndDate\":\"2022-10-04\",\"IsClaimed\":false,\"ResolutionIsBlank\":true,\"Action\":\"claim\"}",
          "description": "The inputs to match an existing transaction",
          "schema": [
            {
              "name": "HierarchyId",
              "kind": "optional",
              "type": "string",
              "description": "<p>The sub-hierarchy at which you want to search for a transaction.</p>\n<p><strong>Note</strong>: By default, this Search API searches the hierarchy at which your user is created. This input lets you search sub-hierarchies without creating multiple users.</p>",
              "example": "5999999999999999999"
            },
            {
              "name": "DatabaseId",
              "kind": "optional",
              "type": "string",
              "description": "Accertify Database ID of the transaction.",
              "example": "1237260313459798901"
            },
            {
              "name": "CaseId",
              "kind": "optional",
              "type": "string",
              "description": "Accertify Transaction ID.",
              "example": "xyz3546dfd"
            },
            {
              "name": "CaseInitStartDate",
              "kind": "optional",
              "type": "string",
              "description": "<p>Case Initial Date, Load date or Import time.</p>\n<p>Combined with the CaseInitEndDate parameter, this allows for a range on the same fields.</p>",
              "example": "2022-09-28"
            },
            {
              "name": "CaseInitEndDate",
              "kind": "optional",
              "type": "string",
              "description": "<p>Case Initial Date, Load date or Import time.</p>\n<p>Combined with the CaseInitStartDate parameter, this allows for a range on the same fields.</p>",
              "example": "2022-10-04"
            },
            {
              "name": "ReplyByDate",
              "kind": "optional",
              "type": "string",
              "description": "<p>Chargeback reply by date formatted in the ISO-8601 Date format.</p>",
              "example": "2024-09-28"
            },
            {
              "name": "CaseTxnStartDate",
              "kind": "optional",
              "type": "string",
              "description": "<p>The date on the transaction.</p>\n<p>Combined with the CaseTxnEndDate parameter, this allows for a range on the same fields.</p>",
              "example": "2022-09-28"
            },
            {
              "name": "CaseTxnEndDate",
              "kind": "optional",
              "type": "string",
              "description": "<p>The date on the transaction.</p>\n<p>Combined with the CaseTxnStartDate parameter, this allows for a range on the same fields.</p>",
              "example": "2022-10-28"
            },
            {
              "name": "IssuerProcessId",
              "kind": "optional",
              "type": "string",
              "description": "Unique Processor identifier forwarded by the issuing bank.",
              "example": "Processor 1"
            },
            {
              "name": "AcquirerProcessId",
              "kind": "optional",
              "type": "string",
              "description": "Unique Processor identifier forwarded by the acquiring bank.",
              "example": "Processor 1"
            },
            {
              "name": "ARN",
              "kind": "optional",
              "type": "string",
              "description": "Chargeback Acquirer Reference Number sent by bank.",
              "example": "T12748945"
            },
            {
              "name": "PaymentFacilitatorId",
              "kind": "optional",
              "type": "string",
              "description": "The identifier for a payment processor. This field lets payment processors narrow the search to only the transactions they processed.\n",
              "example": "Facilitator name"
            },
            {
              "name": "CurrentState",
              "kind": "optional",
              "type": "string",
              "description": "<p>Current state of the transaction.</p>\n<p>This can be:</p>\n<ul>\n<li>Chargeback Current State</li>\n<li>Chargeback Case Closed Code</li>\n<li>Chargeback Workflow Location</li>\n</ul>",
              "example": "Open"
            },
            {
              "name": "TransactionRefNum",
              "kind": "optional",
              "type": "string",
              "description": "<p>A reference number from the transaction.</p>\n<p>This can be:</p>\n<ul>\n<li>Chargeback Order Number</li>\n<li>Chargeback Transaction ID</li>\n<li>Chargeback STAN ID</li>\n<li>Chargeback RRN</li>\n</ul>",
              "example": "123abc45"
            },
            {
              "name": "FollowupIsBlank",
              "kind": "optional",
              "type": "boolean",
              "description": "<p>Whether the chargeback has a follow-up resolution.</p>\n<p>Options are:</p>\n<ul>\n<li>true: There is no follow-up resolution</li>\n<li>false: There is a follow-up resolution</li>\n</ul>",
              "example": false,
              "enum": [
                "true",
                "false"
              ]
            },
            {
              "name": "Followup",
              "kind": "optional",
              "type": "string",
              "description": "You can include one followup as a search criteria with followup name as the value. The APIUSER must have access to this followup.\n",
              "example": "Negative Chargebacks"
            },
            {
              "name": "ResolutionIsBlank",
              "kind": "optional",
              "type": "boolean",
              "description": "<p>Whether the chargeback has a resolution.</p>\n<p>Options are:</p>\n<ul>\n<li>true: There is no resolution</li>\n<li>false: There is a resolution</li>\n</ul>",
              "example": true,
              "enum": [
                "true",
                "false"
              ]
            },
            {
              "name": "Resolution",
              "kind": "optional",
              "type": "string",
              "description": "<p>You can include one resolution filter with either the name of the resolution or unresolved transaction. ResolutionFilter:\"null\". The APIUSER must have access to this resolution if looking for specific resolutions.</p>",
              "example": "Allow"
            },
            {
              "name": "IsClaimed",
              "kind": "optional",
              "type": "boolean",
              "description": "<p>Whether the transaction is currently claimed.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
              "example": false,
              "enum": [
                "true",
                "false"
              ]
            },
            {
              "name": "Action",
              "kind": "optional",
              "type": "string<claim | unclaim | none>",
              "description": "<p>Action for search results. SearchAPI lets you determine whether you claim a live transaction when it finds one.</p>\n<p>Options are:</p>\n<ul>\n<li>claim</li>\n<li>unclaim</li>\n<li>none</li>\n</ul>",
              "example": "claim",
              "enum": [
                "claim",
                "unclaim",
                "none"
              ]
            },
            {
              "name": "MaxRecords",
              "kind": "optional",
              "type": "number<integer>",
              "description": "<p>Maximum records to return in the response.</p>\n<p>By default:</p>\n<ul>\n<li>If no value is specified in this field, the Search API returns 1 record.</li>\n<li>The maximum number you can return is 20 records.</li>\n</ul>\n<p>Regardless of your entry on this field, if the API finds multiple transactions that match your query, the Search API indicates this in the MoreRecords field.</p>\n<p>Both the minimum and maximum number of records allowed is configurable by Accertify.</p>",
              "example": 20,
              "format": "integer"
            }
          ],
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "oauth2",
          "name": "oauth2",
          "kind": "optional",
          "type": "oauth2",
          "description": "<p>OAuth 2.0 Client Credentials authentication is supported in addition to Basic Authentication. Obtain a token by calling the token endpoint with either client credentials in the request body or by passing them via Basic Authentication.\nExample request body: grant_type=client_credentials&#x26;scope=&#x26;client_id=&#x26;client_secret=\nExample Basic Auth token request: Authorization: Basic base64(username</p><div></div>) Request Body: grant_type=client_credentials&#x26;scope=<p></p>"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Transaction is found and column values returned.\n",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"MoreRecords\":false,\"Result\":[{\"ClaimSuccessful\":true,\"Resolution Date\":null,\"BIN\":234567,\"import_time\":\"Fri Aug 26 14:28:53 CDT 2022\",\"DatabaseId\":5237260313459799000,\"resolutions\":null,\"Order Number\":\"ORDER 1\",\"Transaction ID\":null,\"Resolution Reason\":null}]}",
            "description": "Transaction is found and column values returned.\n",
            "customType": "Result",
            "schema": [],
            "modelRef": "#/definitions/Result",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "<p>Error response for requests are sent in following cases:</p>\n<ol>\n<li>One or more invalid or missing inputs.\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n     \"One or more required fields is missing\"\n  ]\n}\n</code></pre>\n</li>\n<li>End Date is before Start Date\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n    \"End Date is before Start Date\"\n  ]\n}\n</code></pre>\n</li>\n<li>Start Date or End Date is too far in the past\n<pre><code>{\n   \"errorMessage\":\"Validation Failed\",\n   \"errorCode\":400,\n   \"errors\":[\n      \"Start Date or End Date is too far in the past\"\n   ]\n}\n</code></pre>\n</li>\n<li>Date range exceeded.\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n     \"Date range exceeded\"\n  ]\n}\n</code></pre>\n</li>\n<li>Invalid fields\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n      \"Invalid fields Name = CaseInitStartDate, Value = 2022-09-31\"\n  ]\n</code></pre>\n</li>\n</ol>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Error response for requests are sent in following cases:</p>\n<ol>\n<li>One or more invalid or missing inputs.\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n     \"One or more required fields is missing\"\n  ]\n}\n</code></pre>\n</li>\n<li>End Date is before Start Date\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n    \"End Date is before Start Date\"\n  ]\n}\n</code></pre>\n</li>\n<li>Start Date or End Date is too far in the past\n<pre><code>{\n   \"errorMessage\":\"Validation Failed\",\n   \"errorCode\":400,\n   \"errors\":[\n      \"Start Date or End Date is too far in the past\"\n   ]\n}\n</code></pre>\n</li>\n<li>Date range exceeded.\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n     \"Date range exceeded\"\n  ]\n}\n</code></pre>\n</li>\n<li>Invalid fields\n<pre><code>{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n      \"Invalid fields Name = CaseInitStartDate, Value = 2022-09-31\"\n  ]\n</code></pre>\n</li>\n</ol>",
            "customType": "ValidationFailedError",
            "schema": [
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "number<integer>",
                "description": "The error code",
                "example": 400,
                "format": "integer"
              },
              {
                "name": "errorMessage",
                "kind": "optional",
                "type": "string",
                "description": "The error message. These are the possible list of error message",
                "example": "Validation Failed"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "object",
                "description": "The error details",
                "example": "Missing fields MerchantNumber",
                "schema": []
              }
            ],
            "modelRef": "#/definitions/ValidationFailedError",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Error response for authorization failures.\n",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Error response for authorization failures.\n",
            "customType": "NotAuthorizedError",
            "schema": [
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "number<integer>",
                "description": "The error code",
                "example": 401,
                "format": "integer"
              },
              {
                "name": "errorMessage",
                "kind": "optional",
                "type": "string",
                "description": "The error message",
                "example": "Not authorized"
              }
            ],
            "modelRef": "#/definitions/NotAuthorizedError",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "<p>Error response for unknown API requests or no matching records.</p>\n<ol>\n<li>Unknown API\n<pre><code>{\n    \"errorMessage\": \"Unknown API\",\n    \"errorCode\": 404,\n    \"errors\": []\n  ]\n}\n</code></pre>\n</li>\n<li>No failed validations but no matching records.\n<pre><code>{\n    \"errorMessage\": \"No matching record found\",\n    \"errorCode\": 404,\n    \"errors\": []\n  ]\n}\n</code></pre>\n</li>\n</ol>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Error response for unknown API requests or no matching records.</p>\n<ol>\n<li>Unknown API\n<pre><code>{\n    \"errorMessage\": \"Unknown API\",\n    \"errorCode\": 404,\n    \"errors\": []\n  ]\n}\n</code></pre>\n</li>\n<li>No failed validations but no matching records.\n<pre><code>{\n    \"errorMessage\": \"No matching record found\",\n    \"errorCode\": 404,\n    \"errors\": []\n  ]\n}\n</code></pre>\n</li>\n</ol>",
            "customType": "NotFoundError",
            "schema": [
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "number<integer>",
                "description": "The error code",
                "example": 404,
                "format": "integer"
              },
              {
                "name": "errorMessage",
                "kind": "optional",
                "type": "string",
                "description": "The error message",
                "example": "Unknown API"
              }
            ],
            "modelRef": "#/definitions/NotFoundError",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Error response when we are unable to process due to internal error.\n",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Error response when we are unable to process due to internal error.\n",
            "customType": "InternalServerError",
            "schema": [
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "number<integer>",
                "description": "The error code",
                "example": 500,
                "format": "integer"
              },
              {
                "name": "errorMessage",
                "kind": "optional",
                "type": "string",
                "description": "The error message",
                "example": "Internal Server Error"
              }
            ],
            "modelRef": "#/definitions/InternalServerError",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://api.accertify.net/api/cbv1/search \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.accertify.net/api/cbv1/search\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.accertify.net/api/cbv1/search\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.accertify.net/api/cbv1/search\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Transaction is found and column values returned.\n{}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Error response for requests are sent in following cases:\n\nOne or more invalid or missing inputs.\n{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n     \"One or more required fields is missing\"\n  ]\n}\n\n\nEnd Date is before Start Date\n{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n    \"End Date is before Start Date\"\n  ]\n}\n\n\nStart Date or End Date is too far in the past\n{\n   \"errorMessage\":\"Validation Failed\",\n   \"errorCode\":400,\n   \"errors\":[\n      \"Start Date or End Date is too far in the past\"\n   ]\n}\n\n\nDate range exceeded.\n{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n     \"Date range exceeded\"\n  ]\n}\n\n\nInvalid fields\n{\n  \"errorMessage\":\"Validation Failed\",\n  \"errorCode\":400,\n  \"errors\":[\n      \"Invalid fields Name = CaseInitStartDate, Value = 2022-09-31\"\n  ]\n{\n  \"errorCode\": 400,\n  \"errorMessage\": \"Validation Failed\",\n  \"errors\": {}\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Error response for authorization failures.\n{\n  \"errorCode\": 401,\n  \"errorMessage\": \"Not authorized\"\n}"
        },
        {
          "id": "response-3-404",
          "language": "404",
          "code": "// Error response for unknown API requests or no matching records.\n\nUnknown API\n{\n    \"errorMessage\": \"Unknown API\",\n    \"errorCode\": 404,\n    \"errors\": []\n  ]\n}\n\n\nNo failed validations but no matching records.\n{\n    \"errorMessage\": \"No matching record found\",\n    \"errorCode\": 404,\n    \"errors\": []\n  ]\n}\n{\n  \"errorCode\": 404,\n  \"errorMessage\": \"Unknown API\"\n}"
        },
        {
          "id": "response-4-500",
          "language": "500",
          "code": "// Error response when we are unable to process due to internal error.\n{\n  \"errorCode\": 500,\n  \"errorMessage\": \"Internal Server Error\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}