Reverse a payment

​

Reverses a prior manual transaction by recording an offsetting entry with the negative of the original amount, referencing the original. Manual transactions have no gateway refund, so this is a compensating entry and the fee's paid status recomputes accordingly. A transaction can be reversed at most once, and a reversal cannot itself be reversed. Requires an API token with write access. Pass an Idempotency-Key header to make retries safe; without one, a retried reversal is rejected with 409.

Path Parameters
  • profile_id
    Type: string
    required

    Unique identifier of the profile the fee belongs to.

  • fee_id
    Type: string
    required

    Unique identifier of the fee the original transaction was recorded against.

  • transaction_id
    Type: string
    required

    Unique identifier of the transaction to reverse.

Headers
  • Idempotency-Key
    Type: string
    max length:  
    255

    Optional client-generated key (at most 255 characters) that makes the request safe to retry. A repeat carrying the same key replays the original reversal (with an Idempotent-Replayed: true header) rather than attempting a second reversal. Without a key, a retried reversal is still rejected with 409, since a transaction can be reversed only once.

Body
application/json
  • reason
    Type: string

    Optional human-readable reason, recorded as the reversal's description. Defaults to a reference to the original transaction.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/apis/payments/profiles/{profile_id}/fees/{fee_id}/transactions/{transaction_id}/reverse
curl https://ff-business-school.fullfabric.cloud/apis/payments/profiles/6385bdd4976a7719120108e9/fees/6977b3de3b5d00baac7cd25e/transactions/6311b20d9a52af7df8000200/reverse \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'FF-Auth: YOUR_SECRET_TOKEN' \
  --data '{
  "reason": "entered in error"
}'

{
  "id": "6311b25a9a52af7df8000abc",
  "state": "succeeded",
  "amount": -500000,
  "currency": "EUR",
  "description": "entered in error",
  "date": "",
  "reference": null,
  "reverses_id": "6311b20d9a52af7df8000200",
  "payable_id": "6977b3de3b5d00baac7cd25e",
  "payable_type": "BookKeeper::PaymentPlan::Fee",
  "profile_id": "6385bdd4976a7719120108e9",
  "created_at": 1744761600,
  "updated_at": 1744761600,
  "payment_id": "6977b3de3b5d00baac7cd25e",
  "fee_id": "6977b3de3b5d00baac7cd25e"
}

The reversal — an offsetting transaction with the negative of the original amount, referencing the original via reverses_id.