CRcreem
Customer Credits - Transactions

Post a transaction

Changed on

Post a multi-entry transaction. Entries must balance (total debits must equal total credits).

post/v1/customer-credits/transactions

Request

Request body

referencestring required

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

idempotency_keystring required

Idempotency key to prevent duplicate transactions

Example request

{
  "reference": "order_xyz",
  "idempotency_key": "idem_abc123",
  "entries": [
    {
      "account_id": "cca_abc123",
      "amount": "1000"
    }
  ]
}

Response

Transaction posted

idstring required

Transaction ID

store_idstring required

Store ID

referencestring required

Reference string

idempotency_keystring required

Idempotency key

reversal_ofstring nullable

ID of the transaction this reverses, if applicable

created_atstring required

Creation timestamp

Example response

{
  "id": "cct_abc123",
  "reference": "order_xyz",
  "reversal_of": "cct_abc123",
  "entries": [
    {
      "id": "cce_abc123",
      "transaction_id": "cct_abc123",
      "account_id": "cca_abc123",
      "amount": "1000"
    }
  ]
}

Changes