Patch transaction metadata

curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "memo": "<string>",
  "reference_number": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  }
}
'

import requests

url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata"

payload = {
    "memo": "<string>",
    "reference_number": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_external_id": "<string>",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_external_id": "<string>",
    "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
            "meaning of life": 42,
            "array": []
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memo: '<string>',
    reference_number: '<string>',
    customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customer_external_id: '<string>',
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    vendor_external_id: '<string>',
    metadata: {
      custom_field: 'value',
      'any valid json': 'below 1kb',
      nested: {'meaning of life': 42, array: []}
    }
  })
};

fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'memo' => '<string>',
    'reference_number' => '<string>',
    'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customer_external_id' => '<string>',
    'vendor_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'vendor_external_id' => '<string>',
    'metadata' => [
        'custom_field' => 'value',
        'any valid json' => 'below 1kb',
        'nested' => [
                'meaning of life' => 42,
                'array' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata"

	payload := strings.NewReader("{\n  \"memo\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customer_external_id\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_external_id\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memo\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customer_external_id\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_external_id\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memo\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customer_external_id\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_external_id\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "type": "Transaction_Metadata",
    "memo": "Example memo to associate with a transaction",
    "reference_number": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    }
  }
}

{
  "type": "InvalidParameters",
  "description": "<string>",
  "error_enum": "InvalidPayload",
  "meta": {}
}

{
  "type": "InvalidParameters",
  "description": "<string>",
  "error_enum": "InvalidPayload",
  "meta": {}
}

PATCH

businesses

{businessId}

bank-transactions

{transactionId}

metadata

Patch transaction metadata

curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "memo": "<string>",
  "reference_number": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  }
}
'

import requests

url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata"

payload = {
    "memo": "<string>",
    "reference_number": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_external_id": "<string>",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_external_id": "<string>",
    "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
            "meaning of life": 42,
            "array": []
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memo: '<string>',
    reference_number: '<string>',
    customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customer_external_id: '<string>',
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    vendor_external_id: '<string>',
    metadata: {
      custom_field: 'value',
      'any valid json': 'below 1kb',
      nested: {'meaning of life': 42, array: []}
    }
  })
};

fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'memo' => '<string>',
    'reference_number' => '<string>',
    'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customer_external_id' => '<string>',
    'vendor_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'vendor_external_id' => '<string>',
    'metadata' => [
        'custom_field' => 'value',
        'any valid json' => 'below 1kb',
        'nested' => [
                'meaning of life' => 42,
                'array' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata"

	payload := strings.NewReader("{\n  \"memo\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customer_external_id\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_external_id\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memo\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customer_external_id\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_external_id\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/bank-transactions/{transactionId}/metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memo\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customer_external_id\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"vendor_external_id\": \"<string>\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"any valid json\": \"below 1kb\",\n    \"nested\": {\n      \"meaning of life\": 42,\n      \"array\": []\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "type": "Transaction_Metadata",
    "memo": "Example memo to associate with a transaction",
    "reference_number": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    }
  }
}

{
  "type": "InvalidParameters",
  "description": "<string>",
  "error_enum": "InvalidPayload",
  "meta": {}
}

{
  "type": "InvalidParameters",
  "description": "<string>",
  "error_enum": "InvalidPayload",
  "meta": {}
}

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 that the transaction to update the metadata for belongs to.

transactionId

string

required

The UUID of the bank transaction to update metadata for.

Body

application/json

Fields to change on a bank transaction's metadata. Omitted fields stay unchanged.

memo

string | null

Memo to store on the transaction. Omit this field to leave the current memo unchanged. Send null to clear it.

reference_number

string | null

Reference number to store on the transaction. Omit this field to leave the current value unchanged. Send null to clear it.

customer_id

string<uuid> | null

Layer customer ID to associate with the transaction. The customer must already exist. Omit this field to leave the current customer unchanged. Send null to clear it.

customer_external_id

string | null

External ID of the customer to associate with the transaction. Layer creates the customer when this external ID does not exist yet. Omit this field to leave the current customer unchanged. Send null to clear it. If you also send customer_id, both values must refer to the same customer.

vendor_id

string<uuid> | null

Layer vendor ID to associate with the transaction. The vendor must already exist. Omit this field to leave the current vendor unchanged. Send null to clear it.

vendor_external_id

string | null

External ID of the vendor to associate with the transaction. Layer creates the vendor when this external ID does not exist yet. Omit this field to leave the current vendor unchanged. Send null to clear it. If you also send vendor_id, both values must refer to the same vendor.

metadata

object | null

Custom metadata for the transaction. Omit this field to leave the current metadata unchanged. Send null to clear it.

Example:

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

Response

data

object

required

Contains metadata associated with a transaction, including an optional memo, customer, and vendor.

Show child attributes

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Platform reporting

Integrations

Patch transaction metadata

Authorizations

Headers

Path Parameters

Body

Response