URL Expired

The URL for this request expired after 30 days.

subaccountId

uuid

required

bankAccountId

uuid

Filter by bank account identifier

cardId

uuid

bankTransactionId

uuid

Filter by bank transaction identifier

cardTransactionId

uuid

Filter by card transaction identifier

minConfidence

string

enum

Defaults to MEDIUM

Filter transaction matches by minimum confidence level. Defaults to MEDIUM, which returns HIGH and MEDIUM matches.

HIGHMEDIUMLOW

Allowed:

HIGH``MEDIUM``LOW

startDate

date

Filter results from this date (inclusive), in YYYY-MM-DD format

endDate

date

Filter results up to this date (inclusive), in YYYY-MM-DD format

limit

integer

1 to 1000

Defaults to 250

Maximum number of items to return

cursor

string

The cursor to use for pagination. Identifies your place on the list

accept

string

enum

Defaults to application/json

Generated from available response content types

application/jsonapplication/problem+json

Allowed:

application/json``application/problem+json

``200 Successful operation

object

items

array of objects

required

items*

object

_links

object

required

HAL-style links to related resources.

_links object

id

uuid

required

The unique identifier of the transaction match.

accountId

uuid

required

The unique identifier of the account that owns this match.

subaccountId

uuid

required

The unique identifier of the subaccount associated with this match.

cardTransactionId

uuid

required

The unique identifier of the matched card transaction.

bankTransactionId

uuid

required

The unique identifier of the matched bank transaction.

confidence

string

enum

required

The confidence level of the match.

• HIGH: Score >= 0.70
• MEDIUM: Score >= 0.50
• LOW: Score >= 0.20

HIGH``MEDIUM``LOW

score

number

required

0 to 1

The numeric match score between 0 and 1, representing how closely the bank and card transactions match.

cardTransaction

object

required

Summary of the matched card transaction.

cardTransaction object

bankTransaction

object

required

Summary of the matched bank transaction.

bankTransaction object

reasons

array of objects

required

Breakdown of the scoring factors that contributed to the match score.

reasons*

object

type

string

enum

The matching factor type.

Amount``Date``Merchant``ReferenceId``PreAuth

score

number

The individual score for this factor.

cardValue

string | null

The value from the card transaction used for comparison. May be a string or numeric value.

bankValue

string | null

The value from the bank transaction used for comparison. May be a string or numeric value.

diff

number

The numeric difference between the card and bank values.

message

string

Human-readable explanation of the score for this factor.

createdAt

date-time

required

Date and time when this match was created, in UTC, following ISO 8601 format.

pagination

object

required

cursor

string

Cursor to use for the next page of results.

hasMore

boolean

required

Whether there are more results available.

``401 Authentication credentials were either missing or incorrect

``403 Authentication credentials used do not have have permissions to perform the request

``500 The server encountered an unexpected condition that prevented it from fulfilling the request

Example Response

{
  "items": [
    {
      "_links": {
        "self": {
          "href": "/transaction-matches/1fcb895e-9217-4a6f-9d10-5a7dcef86c11/b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e"
        },
        "cardTransaction": {
          "href": "/transactions/a9b8c7d6-e5f4-3a2b-1c0d-9e8f7a6b5c4d"
        },
        "bankTransaction": {
          "href": "/bank-transactions/1fcb895e-9217-4a6f-9d10-5a7dcef86c11/7f2a9c4e-3b1d-4e8f-a5c7-6d0e2f9b8a3c"
        }
      },
      "id": "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
      "accountId": "8f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
      "subaccountId": "1fcb895e-9217-4a6f-9d10-5a7dcef86c11",
      "cardTransactionId": "a9b8c7d6-e5f4-3a2b-1c0d-9e8f7a6b5c4d",
      "bankTransactionId": "7f2a9c4e-3b1d-4e8f-a5c7-6d0e2f9b8a3c",
      "confidence": "HIGH",
      "score": 0.85,
      "cardTransaction": {
        "date": "2025-10-15",
        "amount": 42.5,
        "currency": "USD",
        "descriptor": "UBER TRIP"
      },
      "bankTransaction": {
        "date": "2025-10-15",
        "amount": 42.5,
        "currency": "USD",
        "description": "UBER TRIP",
        "merchantName": "Uber"
      },
      "reasons": [
        {
          "type": "Amount",
          "score": 1,
          "cardValue": "42.50",
          "bankValue": "42.50",
          "diff": 0,
          "message": "Exact amount match ($42.50)"
        },
        {
          "type": "Date",
          "score": 0.9,
          "cardValue": "2025-10-15",
          "bankValue": "2025-10-15",
          "diff": 0,
          "message": "Transaction dates within 1 day"
        },
        {
          "type": "Merchant",
          "score": 0.85,
          "cardValue": "UBER TRIP",
          "bankValue": "Uber",
          "diff": 0,
          "message": "Merchant name contains match (Uber)"
        }
      ],
      "createdAt": "2025-10-15T14:31:00.000Z"
    }
  ],

"pagination": {
    "hasMore": false
  }
}

Updated 12 days ago