Bulk match

Confirm matches for multiple bank transactions.

POST /v1/businesses/{businessId}/bank-transactions/bulk-match

Bulk match

cURL

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/bulk-match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "match_pairs": [
    {
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suggested_match_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "UNIT",
    "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
    "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
    "imported_at": "2023-11-07T05:31:56Z",
    "date": "2023-11-07T05:31:56Z",
    "direction": "CREDIT",
    "amount": 123,
    "counterparty_name": "WeWork",
    "description": "WeWork monthly rent payment",
    "account_name": "Plaid Checking",
    "categorizationStatus": "PENDING",
    "category": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category": "RENT",
      "display_name": "Rent",
      "stable_name": "RENT"
    },
    "categorization_method": "SMS",
    "projected_income_category": "REVENUE",
    "suggested_matches": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "matchType": "TRANSFER",
        "details": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "date": "2023-11-07T05:31:56Z",
          "description": "Transfer from SavingsAccount to CheckingAccount"
        }
      }
    ],
    "match": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "match_type": "TRANSFER",
      "bank_transaction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "date": "2023-11-07T05:31:56Z",
        "amount": 123,
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "source": "UNIT",
        "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
        "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
        "imported_at": "2023-11-07T05:31:56Z",
        "direction": "CREDIT",
        "counterparty_name": "WeWork",
        "description": "WeWork monthly rent payment",
        "account_name": "Plaid Checking",
        "categorizationStatus": "PENDING",
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      },
      "details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "Transfer from SavingsAccount to CheckingAccount"
      }
    },
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    },
    "reference_number": "<string>"
  }
]

This should be used when platforms have pre-existing knowledge of what bank transactions are associated with a financial event such as an invoice payment or a payout.

This allows you to match multiple transactions in a single request. Use this endpoint when you already know which suggested_match_id should be confirmed for each transaction.

Request Body

Provide a match_pairs array of transaction-to-suggested-match pairs. Each item in the array confirms one existing suggested match for one transaction.

Response

Returns updated Bank Transactions objects for matched transactions.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type · string

Content-Type must be set to application/json.

Path Parameters

businessId · string · required

The UUID of the business to confirm the matches for.

Body

application/json

match_pairs · object[]

List of transactions with their suggested match.

Show child attributes

Response

200

application/json

Matched transactions.

id · string<uuid>

Unique identifier of the bank transaction.

business_id · string<uuid>

Unique identifier of the business the bank transaction is associated with.

source · enum<string>

Source of the transaction.

Available options: UNIT, PLAID, API, STRIPE, CUSTOM

source_transaction_id · string

External transaction ID from the source platform (e.g, Plaid transaction ID).

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

source_account_id · string

External account ID from the source platform (e.g, Plaid account ID).

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

imported_at · string<date-time>

Timestamp when the transaction was imported.

date · string<date-time>

Date of the transaction.

direction · enum<string>

Direction of the transaction.

Available options: CREDIT, DEBIT

amount · integer<int64>

Transaction amount in cents.

counterparty_name · string | null

Name of the transaction counterparty.

Example:

"WeWork"

description · string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

account_name · string | null

Name of the bank account.

Example:

"Plaid Checking"

categorizationStatus · enum<string>

The status of the transaction’s categorization in Layer’s systems.

Available options: PENDING, READY_FOR_INPUT, CATEGORIZED, SPLIT, LAYER_REVIEW, JOURNALING, MATCHED

category · Account · object

The category assigned to the transaction. Only populated for transactions that have a finalized category.

Account

Exclusion

Split

Show child attributes

categorization_method · enum<string>

The method used to classify the transaction.

Available options: SMS, API, LAYER_AUTO, LAYER_MANUAL

projected_income_category · enum<string>

Available options: REVENUE, EXPENSE, EXCLUDE

suggested_matches · object[]

Show child attributes

match · object

Show child attributes

transaction_tags · object[]

Show child attributes

memo · string | null

Memo for any text you would like to associate with the bank transaction (for example, to display to end users).

metadata · object

Arbitrary custom metadata in JSON format with a size limit of 1KB.

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

reference_number · string | null

Any (typically user-visible) identifier you would like to associate with the bank transaction. Can be used to filter when listing bank transactions.