Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Intake

/claim/intake/retrieveTransactions

Use this endpoint to retrieve transactions that can be selected to add to the claim. Using the customer ID, account number, and submitted claim reasons to retrieve valid transactions.

A default date range is built into the dispute system, so most inputs are optional.

This API can be called multiple times if ad-hoc searching is being performed.

Prerequisite API call:

  • /claim/intake/addClaimReasons
post/claim/intake/retrieveTransactions

Request body

SearchAccountNumbernumber

Account number for searching for transactions that are on a different account than the claim.

Required only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions.

SearchStartDatestring

Search start date for date range search.

Required only if the user is searching for transactions within a certain date range

Format: yyyyMMdd

SearchEndDatestring

Search end date for date range search.

Required only if the user is searching for transactions within a certain date range

Format: yyyyMMdd

SearchAmountstring

Transaction amount to search for.

Required only if the user is searching for a transaction with a specific amount.

SearchMerchantNamestring

Merchant name/Transaction description to search for.

Required only if the user is searching for a transaction with a specific merchant

Example request

{
  "SearchMerchantName": "Amazon"
}

Response

postRetrieveTransactions

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "TransactionList": [
    {
      "AmountInfo": {
        "ISOCodeAlpha": "USD",
        "ISOCurrencyName": "US Dollar"
      }
    }
  ]
}