CRcreem
Customer Credits - Accounts

Reverse a transaction

Changed on

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

Request

Path parameters

idstring required

Request body

transaction_idstring required

ID of the transaction to reverse

Example request

{
  "transaction_id": "cct_abc123"
}

Response

Reversal transaction created

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

  • 071301350724Revision changes
    • info

      api tag Customer Credits - Accounts added

    • info

      api tag Customer Credits - Accounts (Experimental) removed

  • aa593160d96cRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from object to string for status