Create end user transactions (async)
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"reference_id": "my_favourite_transaction_231098",
"balance": 423,
"categories_default": "shopping",
"date": "2020-04-27",
"mcc_code": "<string>",
"order": 123,
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
],
"balances": [
{
"account_id": "checking_account_202348",
"batch_closing_balance": 25000.45
}
]
}
'import requests
url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions"
payload = {
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"reference_id": "my_favourite_transaction_231098",
"balance": 423,
"categories_default": "shopping",
"date": "2020-04-27",
"mcc_code": "<string>",
"order": 123,
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
],
"balances": [
{
"account_id": "checking_account_202348",
"batch_closing_balance": 25000.45
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactions: [
{
account_id: 'checking_account_202348',
amount: -42.42,
currency: 'USD',
description: 'GOOGLE *ADS12340929 [email protected] US',
reference_id: 'my_favourite_transaction_231098',
balance: 423,
categories_default: 'shopping',
date: '2020-04-27',
mcc_code: '<string>',
order: 123,
timestamp: '2021-11-12T10:38:05Z',
transaction_code: 'card'
}
],
balances: [{account_id: 'checking_account_202348', batch_closing_balance: 25000.45}]
})
};
fetch('https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions', 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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'transactions' => [
[
'account_id' => 'checking_account_202348',
'amount' => -42.42,
'currency' => 'USD',
'description' => 'GOOGLE *ADS12340929 [email protected] US',
'reference_id' => 'my_favourite_transaction_231098',
'balance' => 423,
'categories_default' => 'shopping',
'date' => '2020-04-27',
'mcc_code' => '<string>',
'order' => 123,
'timestamp' => '2021-11-12T10:38:05Z',
'transaction_code' => 'card'
]
],
'balances' => [
[
'account_id' => 'checking_account_202348',
'batch_closing_balance' => 25000.45
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions"
payload := strings.NewReader("{\n \"transactions\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"amount\": -42.42,\n \"currency\": \"USD\",\n \"description\": \"GOOGLE *ADS12340929 [email protected] US\",\n \"reference_id\": \"my_favourite_transaction_231098\",\n \"balance\": 423,\n \"categories_default\": \"shopping\",\n \"date\": \"2020-04-27\",\n \"mcc_code\": \"<string>\",\n \"order\": 123,\n \"timestamp\": \"2021-11-12T10:38:05Z\",\n \"transaction_code\": \"card\"\n }\n ],\n \"balances\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"batch_closing_balance\": 25000.45\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"transactions\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"amount\": -42.42,\n \"currency\": \"USD\",\n \"description\": \"GOOGLE *ADS12340929 [email protected] US\",\n \"reference_id\": \"my_favourite_transaction_231098\",\n \"balance\": 423,\n \"categories_default\": \"shopping\",\n \"date\": \"2020-04-27\",\n \"mcc_code\": \"<string>\",\n \"order\": 123,\n \"timestamp\": \"2021-11-12T10:38:05Z\",\n \"transaction_code\": \"card\"\n }\n ],\n \"balances\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"batch_closing_balance\": 25000.45\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transactions\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"amount\": -42.42,\n \"currency\": \"USD\",\n \"description\": \"GOOGLE *ADS12340929 [email protected] US\",\n \"reference_id\": \"my_favourite_transaction_231098\",\n \"balance\": 423,\n \"categories_default\": \"shopping\",\n \"date\": \"2020-04-27\",\n \"mcc_code\": \"<string>\",\n \"order\": 123,\n \"timestamp\": \"2021-11-12T10:38:05Z\",\n \"transaction_code\": \"card\"\n }\n ],\n \"balances\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"batch_closing_balance\": 25000.45\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "<string>",
"transactions_loaded": 123
}Transactions
Create end user transactions (async)
Upload transactions for a specific end user. Does not include enriching transactions — set end user status = ‘ready’ to initiate processing. For synchronous enrichment, please instead use “Enrich transactions (sync). Either timestamp (preferred) or date must be present in the transaction payload.”
POST
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
transactions
Create end user transactions (async)
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"reference_id": "my_favourite_transaction_231098",
"balance": 423,
"categories_default": "shopping",
"date": "2020-04-27",
"mcc_code": "<string>",
"order": 123,
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
],
"balances": [
{
"account_id": "checking_account_202348",
"batch_closing_balance": 25000.45
}
]
}
'import requests
url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions"
payload = {
"transactions": [
{
"account_id": "checking_account_202348",
"amount": -42.42,
"currency": "USD",
"description": "GOOGLE *ADS12340929 [email protected] US",
"reference_id": "my_favourite_transaction_231098",
"balance": 423,
"categories_default": "shopping",
"date": "2020-04-27",
"mcc_code": "<string>",
"order": 123,
"timestamp": "2021-11-12T10:38:05Z",
"transaction_code": "card"
}
],
"balances": [
{
"account_id": "checking_account_202348",
"batch_closing_balance": 25000.45
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactions: [
{
account_id: 'checking_account_202348',
amount: -42.42,
currency: 'USD',
description: 'GOOGLE *ADS12340929 [email protected] US',
reference_id: 'my_favourite_transaction_231098',
balance: 423,
categories_default: 'shopping',
date: '2020-04-27',
mcc_code: '<string>',
order: 123,
timestamp: '2021-11-12T10:38:05Z',
transaction_code: 'card'
}
],
balances: [{account_id: 'checking_account_202348', batch_closing_balance: 25000.45}]
})
};
fetch('https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions', 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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'transactions' => [
[
'account_id' => 'checking_account_202348',
'amount' => -42.42,
'currency' => 'USD',
'description' => 'GOOGLE *ADS12340929 [email protected] US',
'reference_id' => 'my_favourite_transaction_231098',
'balance' => 423,
'categories_default' => 'shopping',
'date' => '2020-04-27',
'mcc_code' => '<string>',
'order' => 123,
'timestamp' => '2021-11-12T10:38:05Z',
'transaction_code' => 'card'
]
],
'balances' => [
[
'account_id' => 'checking_account_202348',
'batch_closing_balance' => 25000.45
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions"
payload := strings.NewReader("{\n \"transactions\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"amount\": -42.42,\n \"currency\": \"USD\",\n \"description\": \"GOOGLE *ADS12340929 [email protected] US\",\n \"reference_id\": \"my_favourite_transaction_231098\",\n \"balance\": 423,\n \"categories_default\": \"shopping\",\n \"date\": \"2020-04-27\",\n \"mcc_code\": \"<string>\",\n \"order\": 123,\n \"timestamp\": \"2021-11-12T10:38:05Z\",\n \"transaction_code\": \"card\"\n }\n ],\n \"balances\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"batch_closing_balance\": 25000.45\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"transactions\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"amount\": -42.42,\n \"currency\": \"USD\",\n \"description\": \"GOOGLE *ADS12340929 [email protected] US\",\n \"reference_id\": \"my_favourite_transaction_231098\",\n \"balance\": 423,\n \"categories_default\": \"shopping\",\n \"date\": \"2020-04-27\",\n \"mcc_code\": \"<string>\",\n \"order\": 123,\n \"timestamp\": \"2021-11-12T10:38:05Z\",\n \"transaction_code\": \"card\"\n }\n ],\n \"balances\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"batch_closing_balance\": 25000.45\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transactions\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"amount\": -42.42,\n \"currency\": \"USD\",\n \"description\": \"GOOGLE *ADS12340929 [email protected] US\",\n \"reference_id\": \"my_favourite_transaction_231098\",\n \"balance\": 423,\n \"categories_default\": \"shopping\",\n \"date\": \"2020-04-27\",\n \"mcc_code\": \"<string>\",\n \"order\": 123,\n \"timestamp\": \"2021-11-12T10:38:05Z\",\n \"transaction_code\": \"card\"\n }\n ],\n \"balances\": [\n {\n \"account_id\": \"checking_account_202348\",\n \"batch_closing_balance\": 25000.45\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "<string>",
"transactions_loaded": 123
}Authorizations
Path Parameters
Body
application/json
Was this page helpful?
⌘I