BYbyaccrue
Rewards

Get Issued Reward by ID

Look up a single issued reward by ID. Returns a unified Reward resource when found, or { data: null } when not found.

get/api/v1/rewards/{id}

Request

Path parameters

idstring uuid required

Reward ID (immediate credit or pre-issued reward).

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK — reward found or data is null

Example response

{
  "data": {
    "attributes": {
      "kind": "immediate",
      "amount": 500,
      "walletId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Credited",
      "claimExpiresAt": "2026-09-15T12:00:00.000Z",
      "message": "Thank you for your loyalty!",
      "reasonCode": "CX-COMPENSATION-001",
      "costCenter": "CX-SUPPORT",
      "notificationEmail": "agent@partner.example"
    }
  }
}

Changes

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