Skip to main content

A token transaction records a credit or debit to a member's token balance within a company, including transfers between members.

​
id
string
required

The unique identifier for the company token transaction.

​
transaction_type
enum<string>
required

The direction of this token transaction (add, subtract, or transfer).

Available options:
add,
subtract,
transfer
​
amount
number
required

The token amount for this transaction. Always a positive value regardless of transaction type.

Example:

6.9

​
description
string | null
required

Free-text description explaining the reason for this token transaction. Null if no description was provided.

Example:

"Reward for completing onboarding"

​
created_at
string<date-time>
required

The datetime the company token transaction was created.

Example:

"2023-12-01T05:00:00.401Z"

​
linked_transaction_id
string | null
required

The ID of the corresponding transaction on the other side of a transfer. Null if this is not a transfer transaction.

​
idempotency_key
string | null
required

A unique key used to prevent duplicate transactions when retrying API requests. Null if no idempotency key was provided.

Example:

"txn_reward_usr_123_2024"

​
user
object
required

The user whose token balance was affected by this transaction.

​
member
object
required

The member whose token balance was affected by this transaction.

​
company
object
required

The company whose token balance this transaction affects.