Skip to main content
{
	"amount": 6.9,
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"route": "<string>",
		"title": "<string>"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"description": "Reward for completing onboarding",
	"id": "<string>",
	"idempotency_key": "txn_reward_usr_123_2024",
	"linked_transaction_id": "<string>",
	"member": {
		"id": "<string>"
	},
	"transaction_type": "add",
	"user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	}
}
​
amount
number
required
The token amount for this transaction. Always a positive value regardless of transaction type.Example: 6.9
​
company
object
required
The company whose token balance this transaction affects.
​
created_at
string<date-time>
required
The datetime the company token transaction was created.Example: 2023-12-01T05:00:00.401Z
​
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
​
id
string
required
The unique identifier for the company token 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
​
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.
​
member
object
required
The member whose token balance was affected by this transaction.
​
transaction_type
CompanyTokenTransactionTypes
required
The direction of this token transaction (add, subtract, or transfer).Available options: add, subtract, transfer
​
user
object
required
The user whose token balance was affected by this transaction.