%PDF- %GIF98; %PNG;
Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Create Loyalty Reward Request
A request to create a loyalty reward.
## Structure
`CreateLoyaltyRewardRequest`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `reward` | [`LoyaltyReward`](/doc/models/loyalty-reward.md) | Required | Represents a contract to redeem loyalty points for a [reward tier](/doc/models/loyalty-program-reward-tier.md) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. For more information, see [Redeem loyalty rewards](https://developer.squareup.com/docs/loyalty-api/overview#redeem-loyalty-rewards). | getReward(): LoyaltyReward | setReward(LoyaltyReward reward): void |
| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateLoyaltyReward` request.<br>Keys can be any valid string, but must be unique for every request.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
## Example (as JSON)
```json
{
"idempotency_key": "18c2e5ea-a620-4b1f-ad60-7b167285e451",
"reward": {
"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
"order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY",
"reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f"
}
}
```