Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Autogenerated input type of CreateCompanyTokenTransaction

amount
number
required

The positive number of tokens to transact. For example, 100.0 for 100 tokens.

Example:

6.9

company_id
string
required

The unique identifier of the company to create the transaction in, starting with 'biz_'.

Example:

"biz_xxxxxxxxxxxxxx"

destination_user_id
string
required

The unique identifier of the user receiving the tokens. Required when the transaction type is 'transfer'.

transaction_type
string
required
Allowed value: "transfer"
user_id
string
required

The unique identifier of the user whose token balance will be affected, starting with 'user_'.

Example:

"user_xxxxxxxxxxxxx"

description
string | null

A human-readable description of why the transaction was created.

idempotency_key
string | null

A unique key to prevent duplicate transactions. Use a UUID or similar unique string.

Response

A successful response

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

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
enum<string>
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.