Redemptions

List participant redemptions

List redemptions for a participant. The created_after and created_before filters use redemption creation (authorization) time, including for redemptions captured later.

get/v1/participants/{participant_id}/redemptions

Request

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

Path parameters

participant_idstring required

The participant's id, or ext: followed by the participant's external_id.

Query parameters

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

status'PENDING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'PARTIALLY_REVERSED' | 'FULLY_REVERSED'

Filter by redemption status

reward_idstring uuid

Return only redemptions of this reward.

created_afterstring date-time

Return only records created after this time, RFC 3339.

created_beforestring date-time

Return only records created before this time, RFC 3339.

Response

List of redemptions

Example response

{
  "data": [
    {
      "amount": "1000.00",
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "capture_journal_entry_id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
      "captured_at": "2027-01-15T10:30:00Z",
      "created_at": "2027-01-15T10:30:00Z",
      "description": "Redeemed: Gift Card",
      "expires_at": "2027-12-31T23:59:59Z",
      "failure_reason": "fulfillment_failed",
      "fulfillment": {
        "claim_url": "https://claim.example.com/abc123",
        "created_at": "2027-01-15T10:30:00Z",
        "face_value": {
          "amount_minor": 2500,
          "currency": "USD"
        },
        "failure_reason": "provider_permanent_error",
        "provider": "TREMENDOUS",
        "provider_order_id": "ord_abc123",
        "resolved_at": "2027-01-15T10:30:00Z",
        "status": "PROCESSING",
        "updated_at": "2027-01-15T10:30:00Z"
      },
      "id": "7f422b43-4ba2-41c7-b05d-e4e90b68e978",
      "journal_entry_id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
      "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "quantity": 2,
      "release_journal_entry_id": "657a0312-1aaa-4ba7-842b-edfbb39edf14",
      "released_amount": "1000.00",
      "reservation_id": "5d1f8a26-3c79-4e0b-9a64-b2e7c1d85f10",
      "resolved_at": "2027-01-15T10:30:00Z",
      "reversed_amount": "0.00",
      "reward_id": "2b7a9c4e-1f3d-4a8b-9e6c-5a1d3f7b8c08",
      "status": "COMPLETED",
      "unit_cost": "500.00",
      "updated_at": "2027-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

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