Reverse a transaction

Reverse a previous credit or debit on this account. Creates a new transaction that undoes the original, preserving the full history.

POST /v1/customer-credits/accounts/{id}/reverse

Reverse a transaction

cURL

curl --request POST \
  --url https://api.creem.io/v1/customer-credits/accounts/{id}/reverse \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transaction_id": "cct_abc123"
}
'

201

{
  "id": "cct_abc123",
  "store_id": "<string>",
  "reference": "order_xyz",
  "idempotency_key": "<string>",
  "entries": [
    {
      "id": "cce_abc123",
      "transaction_id": "cct_abc123",
      "account_id": "cca_abc123",
      "amount": "1000",
      "created_at": "<string>"
    }
  ],
  "created_at": "<string>",
  "reversal_of": "cct_abc123"
}

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.

Path Parameters

id · string · required

Body

application/json

transaction_id · string · required

ID of the transaction to reverse

Example:

"cct_abc123"

Response

201

application/json

Reversal transaction created

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

Show child attributes

created_at · string · required

Creation timestamp

reversal_of · object

ID of the transaction this reverses, if applicable

Example:

"cct_abc123"