Categorize transactions in bulk
Assigns categories to 1-100 transactions in one call. Requires the transactions.annotate:write scope (transactions:write reaches it too), writes_enabled, and an Idempotency-Key.
The outcome is PARTIAL by design: a mixed result is 200, applied_count says how many rows were written, and every item reports itself as applied, not_found, invalid_category, version_conflict, or split. To retry the ones that failed, send a NEW batch with a FRESH Idempotency-Key — reusing the original key replays the original response and changes nothing, and reusing it with a corrected body is a 409.
Exclusions are applied server-side from this connection's privacy settings: rows on excluded accounts come back not_found, and an excluded category comes back invalid_category.
curl -X POST "https://api.403fin.io/v1/transactions/categorize" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: example_string" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"items": [
{
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"expected_version": 42
}
]
}'
import requests
import json
url = "https://api.403fin.io/v1/transactions/categorize"
headers = {
"Content-Type": "application/json",
"Idempotency-Key": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"items": [
{
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"expected_version": 42
}
]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.403fin.io/v1/transactions/categorize", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"items": [
{
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"expected_version": 42
}
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"items": [
{
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"expected_version": 42
}
]
}`)
req, err := http.NewRequest("POST", "https://api.403fin.io/v1/transactions/categorize", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Idempotency-Key", "example_string")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.403fin.io/v1/transactions/categorize')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Idempotency-Key'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"items": [
{
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"expected_version": 42
}
]
}'
response = http.request(request)
puts response.body
{
"data": {
"applied_count": 10,
"results": [
{
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "applied"
}
]
},
"pagination": {
"next_cursor": "example_string",
"has_more": true
},
"redacted_fields": [
"example_string"
],
"filtered": true
}
{}
/v1/transactions/categorize
Target server for requests. Edit to use your own host.
An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
An opaque ff_ credential presented in the X-API-Key header.
The media type of the request body
A caller-chosen unique key (1-128 chars) that makes the write idempotent. A retry with the SAME key against the SAME operation, resource, and body replays the original response (Idempotency-Replayed: true). The same key with anything different — a changed body, a different endpoint, or a different {id} — is a 409 conflict; a still-in-flight duplicate is 409 with Retry-After. Required on every write. Stored for 24 hours. The key is bound to the target, not only to the payload, so reusing one key across two deletes (which carry no body at all) conflicts rather than replaying the first delete's response.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.
Headers
A caller-chosen unique key (1-128 chars) that makes the write idempotent. A retry with the SAME key against the SAME operation, resource, and body replays the original response (Idempotency-Replayed: true). The same key with anything different — a changed body, a different endpoint, or a different {id} — is a 409 conflict; a still-in-flight duplicate is 409 with Retry-After. Required on every write. Stored for 24 hours.
The key is bound to the target, not only to the payload, so reusing one key across two deletes (which carry no body at all) conflicts rather than replaying the first delete's response.
Body
Responses
The result of a bulk categorize. This call is PARTIAL by design: a mixed outcome is still 200, and every submitted item explains itself. Retry the items you want to retry with a FRESH Idempotency-Key — replaying the original key returns the original response, corrections included or not.
Cursor pagination state, present on list endpoints.
Field ids stripped from the payload by connection scope.
True when row or aggregate filtering is in effect for this response.