Skip to main content
POST
Post a transaction

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Body

application/json
reference
string
required

Your reference ID to link this transaction to an event in your system

Example:

"order_xyz"

idempotency_key
string
required

Idempotency key to prevent duplicate transactions

Example:

"idem_abc123"

entries
object[]
required

Array of entries. Must have at least 2 entries and the total debits must equal total credits.

Response

Transaction posted

id
string
required

Transaction ID

Example:

"cct_abc123"

store_id
string
required

Store ID

reference
string
required

Reference string

Example:

"order_xyz"

idempotency_key
string
required

Idempotency key

entries
object[]
required

Transaction entries

created_at
string
required

Creation timestamp

reversal_of
string | null

ID of the transaction this reverses, if applicable

Example:

"cct_abc123"