Skip to main content
PUT
/
v1
/
businesses
/
{businessId}
/
bank-transactions
/
{transactionId}
/
match
Match bank transaction
curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "Confirm_Match",
  "match_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt

Use this file to discover all available pages before exploring further.

This should be used when platforms have pre-existing knowledge of what bank transactions are associated with a financial event, or when a user confirms a suggested match in a UI. If you are using Layer’s Bank Transactions embedded component, you are unlikely to need to call this endpoint directly. Suggested matches can be found on a Bank Transaction Object.

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

ID of the business the bank transaction is associated with.

​
transactionId
string
required

The UUID of the bank transaction to match.

Body

application/json
​
type
string

Polymorphic discriminator, this must be set as Confirm_Match.

Example:

"Confirm_Match"

​
match_id
string<uuid>

ID of the suggested match to confirm.

Response

​
id
string<uuid>

Layer's UUID for the match.

​
match_type
enum<string>

Type of the object to match.

Available options:
TRANSFER,
INVOICE_PAYMENT,
PAYOUT
​
bank_transaction
object
​
details
object