BYbyaccrue
Rewards

Issue Reward

Issue a reward to a recipient identified by phone number. If the recipient has exactly one active wallet, the reward is credited immediately (kind: immediate, status: Credited). Otherwise, if no blocking wallet exists, a pre-issued reward is created (kind: preIssued, status: Created). All responses use the unified Reward resource type. Requires an idempotencyKey. Retries are safe when the full request body is unchanged — the API fingerprints the body server-side and replays the prior result for matching key + fingerprint pairs.

post/api/v1/rewards

Request

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

Request body

Example request

{
  "data": {
    "attributes": {
      "phoneNumber": "+15551234567",
      "amount": 500,
      "idempotencyKey": "reward-2025-06-11-001",
      "message": "Thanks for being a valued customer!",
      "reasonCode": "CX-COMPENSATION-001",
      "costCenter": "CX-SUPPORT",
      "notificationEmail": "agent@partner.example"
    }
  }
}

Response

Reward issued successfully. Response is always type: Reward; use kind, status, and capability flags to interpret the outcome.

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.