Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
bank-transactions
/
bulk-match
Bulk match
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"
    }
  ]
}
'
{
  "data": [
    {
      "type": "Bank_Transaction",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
      "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
      "external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "imported_at": "2023-11-07T05:31:56Z",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "counterparty_name": "WeWork",
      "description": "WeWork monthly rent payment",
      "account_name": "Plaid Checking",
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "category": "RENT",
        "display_name": "Rent",
        "stable_name": "RENT"
      },
      "suggested_matches": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "details": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 123,
            "date": "2023-11-07T05:31:56Z",
            "description": "Transfer from SavingsAccount to CheckingAccount"
          }
        }
      ],
      "match": {
        "type": "Match",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bank_transaction": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "date": "2023-11-07T05:31:56Z",
          "amount": 123,
          "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
          "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
          "external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "imported_at": "2023-11-07T05:31:56Z",
          "counterparty_name": "WeWork",
          "description": "WeWork monthly rent payment",
          "account_name": "Plaid Checking",
          "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.

Response

Matched transactions.

data
object[]
required