Record custom account transaction
curl --request POST \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'transaction={
"amount": 123,
"direction": "DEBIT",
"date": "<string>",
"description": "<string>",
"external_id": "<string>",
"merchant_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>",
"memo": "<string>",
"metadata": {
"custom_field": "value",
"any valid json": "below 1kb",
"nested": {
"meaning of life": 42,
"array": []
}
},
"reference_number": "<string>",
"tags": [
{
"key": "department",
"value": "sales",
"dimension_display_name": "Department",
"value_display_name": "Sales Department"
}
]
};type=application/json' \
--form files=@example-fileimport requests
url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record"
files = { "files": ("example-file", open("example-file", "rb")) }
files["transaction"] = (None, "{\n \"amount\": 123,\n \"direction\": \"DEBIT\",\n \"date\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<string>\",\n \"merchant_name\": \"<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 \"memo\": \"<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 \"reference_number\": \"<string>\",\n \"tags\": [\n {\n \"key\": \"department\",\n \"value\": \"sales\",\n \"dimension_display_name\": \"Department\",\n \"value_display_name\": \"Sales Department\"\n }\n ]\n}", "application/json")
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('transaction', '{
"amount": 123,
"direction": "DEBIT",
"date": "<string>",
"description": "<string>",
"external_id": "<string>",
"merchant_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>",
"memo": "<string>",
"metadata": {
"custom_field": "value",
"any valid json": "below 1kb",
"nested": {
"meaning of life": 42,
"array": []
}
},
"reference_number": "<string>",
"tags": [
{
"key": "department",
"value": "sales",
"dimension_display_name": "Department",
"value_display_name": "Sales Department"
}
]
}');
form.append('files', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record', 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}/custom-accounts/{customAccountId}/transactions/record",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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}/custom-accounts/{customAccountId}/transactions/record"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"type": "Bank_Transaction",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "PLAID",
"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",
"direction": "DEBIT",
"amount": 123,
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "RENT",
"display_name": "Rent",
"stable_name": "RENT"
},
"categorization_method": "API",
"tax_code": "GST_PST_BC",
"tax_options": {
"canada": [
{
"code": "GST_PST_BC",
"display_name": "GST/PST BC",
"type": "TAXABLE",
"total_rate": "12.000",
"components": [
{
"code": "PST_BC",
"type": "GST",
"rate": "7.000",
"recoverable": true,
"province": "BRITISH_COLUMBIA"
}
],
"province": "BRITISH_COLUMBIA",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25"
}
]
},
"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": {
"type": "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": "PLAID",
"source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
"source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z",
"direction": "DEBIT",
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"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>"
}
}{
"data": {
"type": "Bank_Transaction",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "PLAID",
"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",
"direction": "DEBIT",
"amount": 123,
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "RENT",
"display_name": "Rent",
"stable_name": "RENT"
},
"categorization_method": "API",
"tax_code": "GST_PST_BC",
"tax_options": {
"canada": [
{
"code": "GST_PST_BC",
"display_name": "GST/PST BC",
"type": "TAXABLE",
"total_rate": "12.000",
"components": [
{
"code": "PST_BC",
"type": "GST",
"rate": "7.000",
"recoverable": true,
"province": "BRITISH_COLUMBIA"
}
],
"province": "BRITISH_COLUMBIA",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25"
}
]
},
"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": {
"type": "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": "PLAID",
"source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
"source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z",
"direction": "DEBIT",
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"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>"
}
}{
"type": "InvalidParameters",
"description": "<string>",
"error_enum": "InvalidPayload",
"meta": {}
}{
"type": "InvalidParameters",
"description": "<string>",
"error_enum": "InvalidPayload",
"meta": {}
}Bank Transactions
Record custom account transaction
Record a one-off expense from a personal account or another transaction not recorded in an existing bank feed. Receipts can be included.
POST
/
v1
/
businesses
/
{businessId}
/
custom-accounts
/
{customAccountId}
/
transactions
/
record
Record custom account transaction
curl --request POST \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'transaction={
"amount": 123,
"direction": "DEBIT",
"date": "<string>",
"description": "<string>",
"external_id": "<string>",
"merchant_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>",
"memo": "<string>",
"metadata": {
"custom_field": "value",
"any valid json": "below 1kb",
"nested": {
"meaning of life": 42,
"array": []
}
},
"reference_number": "<string>",
"tags": [
{
"key": "department",
"value": "sales",
"dimension_display_name": "Department",
"value_display_name": "Sales Department"
}
]
};type=application/json' \
--form files=@example-fileimport requests
url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record"
files = { "files": ("example-file", open("example-file", "rb")) }
files["transaction"] = (None, "{\n \"amount\": 123,\n \"direction\": \"DEBIT\",\n \"date\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<string>\",\n \"merchant_name\": \"<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 \"memo\": \"<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 \"reference_number\": \"<string>\",\n \"tags\": [\n {\n \"key\": \"department\",\n \"value\": \"sales\",\n \"dimension_display_name\": \"Department\",\n \"value_display_name\": \"Sales Department\"\n }\n ]\n}", "application/json")
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('transaction', '{
"amount": 123,
"direction": "DEBIT",
"date": "<string>",
"description": "<string>",
"external_id": "<string>",
"merchant_name": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>",
"memo": "<string>",
"metadata": {
"custom_field": "value",
"any valid json": "below 1kb",
"nested": {
"meaning of life": 42,
"array": []
}
},
"reference_number": "<string>",
"tags": [
{
"key": "department",
"value": "sales",
"dimension_display_name": "Department",
"value_display_name": "Sales Department"
}
]
}');
form.append('files', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record', 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}/custom-accounts/{customAccountId}/transactions/record",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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}/custom-accounts/{customAccountId}/transactions/record"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/{customAccountId}/transactions/record")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"transaction\"\r\nContent-Type: application/json\r\n\r\n{\r\n \"amount\": 123,\r\n \"direction\": \"DEBIT\",\r\n \"date\": \"<string>\",\r\n \"description\": \"<string>\",\r\n \"external_id\": \"<string>\",\r\n \"merchant_name\": \"<string>\",\r\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"customer_external_id\": \"<string>\",\r\n \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\r\n \"vendor_external_id\": \"<string>\",\r\n \"memo\": \"<string>\",\r\n \"metadata\": {\r\n \"custom_field\": \"value\",\r\n \"any valid json\": \"below 1kb\",\r\n \"nested\": {\r\n \"meaning of life\": 42,\r\n \"array\": []\r\n }\r\n },\r\n \"reference_number\": \"<string>\",\r\n \"tags\": [\r\n {\r\n \"key\": \"department\",\r\n \"value\": \"sales\",\r\n \"dimension_display_name\": \"Department\",\r\n \"value_display_name\": \"Sales Department\"\r\n }\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"type": "Bank_Transaction",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "PLAID",
"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",
"direction": "DEBIT",
"amount": 123,
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "RENT",
"display_name": "Rent",
"stable_name": "RENT"
},
"categorization_method": "API",
"tax_code": "GST_PST_BC",
"tax_options": {
"canada": [
{
"code": "GST_PST_BC",
"display_name": "GST/PST BC",
"type": "TAXABLE",
"total_rate": "12.000",
"components": [
{
"code": "PST_BC",
"type": "GST",
"rate": "7.000",
"recoverable": true,
"province": "BRITISH_COLUMBIA"
}
],
"province": "BRITISH_COLUMBIA",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25"
}
]
},
"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": {
"type": "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": "PLAID",
"source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
"source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z",
"direction": "DEBIT",
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"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>"
}
}{
"data": {
"type": "Bank_Transaction",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "PLAID",
"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",
"direction": "DEBIT",
"amount": 123,
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "RENT",
"display_name": "Rent",
"stable_name": "RENT"
},
"categorization_method": "API",
"tax_code": "GST_PST_BC",
"tax_options": {
"canada": [
{
"code": "GST_PST_BC",
"display_name": "GST/PST BC",
"type": "TAXABLE",
"total_rate": "12.000",
"components": [
{
"code": "PST_BC",
"type": "GST",
"rate": "7.000",
"recoverable": true,
"province": "BRITISH_COLUMBIA"
}
],
"province": "BRITISH_COLUMBIA",
"effective_from": "2023-12-25",
"effective_to": "2023-12-25"
}
]
},
"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": {
"type": "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": "PLAID",
"source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
"source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
"external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imported_at": "2023-11-07T05:31:56Z",
"direction": "DEBIT",
"counterparty_name": "WeWork",
"description": "WeWork monthly rent payment",
"account_name": "Plaid Checking",
"categorizationStatus": "CATEGORIZED",
"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>"
}
}{
"type": "InvalidParameters",
"description": "<string>",
"error_enum": "InvalidPayload",
"meta": {}
}{
"type": "InvalidParameters",
"description": "<string>",
"error_enum": "InvalidPayload",
"meta": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The UUID of the business.
The UUID of the custom account to record the transaction on.
Body
multipart/form-data
Response
An existing transaction with the same external_id was returned.
Show child attributes
Show child attributes