Skip to main content
POST
Categorize a transaction

Authorizations

Authorization
string
header
required

Authenticate with your secret API key as a bearer token: Authorization: Bearer 3r_live_.... Keys are issued per partner from the dashboard; use 3r_test_... against the sandbox. Never expose a secret key in client-side code.

Headers

Idempotency-Key
string

A unique key (e.g. a UUID) that makes a write safe to retry. Replaying the same key returns the original result instead of creating a duplicate.

Maximum string length: 255

Body

application/json
businessId
string
required
Example:

"biz_9f2"

description
string
required
Example:

"UBER *TRIP 2AM"

amount
integer
required

Minor units.

Example:

420000

currency
string
Example:

"NGN"

direction
enum<string>
Available options:
debit,
credit
Example:

"debit"

Response

A categorization suggestion.

accountId
string
required
Example:

"acc_travel"

confidence
number<float>
required
Required range: 0 <= x <= 1
Example:

0.94

accountName
string
Example:

"Travel & Transport"

alternatives
object[]