Redemptions

Reverse a redemption

Reverse all or part of a redemption, returning funds to the participant.

post/v1/redemptions/{redemption_id}/reverse

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/redemptions/{redemption_id}/reverse
  • Auth: HTTP bearer

Path parameters

redemption_idstring uuid required

The redemption's id.

Headers

Idempotency-Keystring

A key you choose to make this request safe to retry: 1 to 255 printable ASCII characters. Send the same key with the same request to get the first response again, marked Idempotent-Replayed: true. Routes that return a secret once, and claim links, do not replay a response. Event ingest uses the key as the event's identity.

Request body

amountstring

Amount to reverse for raw or AMOUNT_BASED redemptions (omit for full reversal, decimal string)

idempotency_keystring

Your key for this reversal. You can send it in the Idempotency-Key header instead; when both are sent they must match.

quantityinteger

Units to reverse for UNIT_BASED catalog redemptions (omit for full reversal)

reasonstring required

Why this reversal is being made (1-500 chars)

Example request

{
  "amount": "500.00",
  "idempotency_key": "reverse-12345",
  "quantity": 1,
  "reason": "Customer refund request"
}

Response

Reversal created

amountstring

Amount credited back to the participant's balance (decimal string)

created_atstring date-time

When this reversal was created

idstring uuid

Unique identifier for this reversal

journal_entry_idstring uuid

The ledger journal entry created by this reversal

quantityinteger

Units reversed (UNIT_BASED catalog redemptions only)

reasonstring

Why this reversal was made

redemption_idstring uuid

The redemption that was reversed

Example response

{
  "amount": "500.00",
  "created_at": "2027-01-15T10:30:00Z",
  "id": "9e3c5b71-6d28-4a94-8f1e-0c7b2a4d6e11",
  "journal_entry_id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
  "quantity": 1,
  "reason": "Customer refund request",
  "redemption_id": "7f422b43-4ba2-41c7-b05d-e4e90b68e978"
}

Changes

No recorded changes to this operation across all 1 revision of this API.