Skip to main content
number
required
The token amount for this transaction. Always a positive value regardless of transaction type.Example: 6.9
object
required
The company whose token balance this transaction affects.
string<date-time>
required
The datetime the company token transaction was created.Example: 2023-12-01T05:00:00.401Z
string | null
required
Free-text description explaining the reason for this token transaction. Null if no description was provided.Example: Reward for completing onboarding
string
required
The unique identifier for the company token transaction.
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
string | null
required
The ID of the corresponding transaction on the other side of a transfer. Null if this is not a transfer transaction.
object
required
The member whose token balance was affected by this transaction.
CompanyTokenTransactionTypes
required
The direction of this token transaction (add, subtract, or transfer).Available options: add, subtract, transfer
object
required
The user whose token balance was affected by this transaction.