Skip to content
Indiana
Dashboard
Docs
Browse docs / Confirm reward product claim

Confirm reward product claim

POST/api/v1/rewards/product/claim

After reviewing the reward product and renewal amount, the customer explicitly accepts Checkout using the original redemption and request ID. Holdings require verified payment.

SDK 0.0.1Updated

Make the request

After reviewing the reward product and renewal amount, the customer explicitly accepts Checkout using the original redemption and request ID. Holdings require verified payment.

Credential
Customer token only. Identity is bound to the token.
Permission
offers:resolve
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/rewards/product/claim" \  -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "redemptionId": "00000000-0000-4000-8000-000000000001",  "currency": "USD",  "requestId": "00000000-0000-4000-8000-000000000001",  "accepted": true}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

redemptionIduuidRequired

The redemptionId value for this operation. Its accepted type and constraints are listed above and below.

currencyenumRequired

Currency code supported by the published price.

Show allowed values

"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"

requestIduuidRequired

Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.

acceptedtrueRequired

Whether business rules accepted the operation. HTTP 200 does not imply accepted is true.

Response fields

Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.

HTTP 200 · application/json

requestIduuidRequired

Server-generated HTTP request UUID. Include it when reporting a failed request.

scopeobjectRequired

The App and environment of this response. Headers only verify scope; they cannot switch key scope.

Show child fields
projectIdstringRequired

App ID bound to the credential.

minLength: 1

environmentenumRequired

Separate data scope: sandbox or live.

Show allowed values

"sandbox""live"

checkoutobject | objectRequired

The checkout value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
type"checkout" | "subscription"Required

The type value for this operation. Its accepted type and constraints are listed above and below.

orderIduuidOptional

The orderId value for this operation. Its accepted type and constraints are listed above and below.

productVersionIduuid | uuidRequired

The productVersionId value for this operation. Its accepted type and constraints are listed above and below.

currencyenum | enumRequired

Currency code supported by the published price.

durationobject | object | object | object | object | objectRequired

The duration value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
type"once" | "repeating" | "forever" | "once" | "repeating" | "forever"Required

The type value for this operation. Its accepted type and constraints are listed above and below.

monthsinteger | integerOptional

The months value for this operation. Its accepted type and constraints are listed above and below.

renewalAmountMinorinteger | integerRequired

The renewalAmountMinor value for this operation. Its accepted type and constraints are listed above and below.

statusenum | enumRequired

The status value for this operation. Its accepted type and constraints are listed above and below.

urluri | nullOptional

Hosted checkout URL. Verified provider notifications confirm payment.

operationIduuidOptional

Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.

membershipIduuidOptional

The membershipId value for this operation. Its accepted type and constraints are listed above and below.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse the App and environment bound to the credential.

Common failures

  • UNAUTHENTICATED

    Recovery
    Verify the key or refresh the expired customer token once.
  • FORBIDDEN

    Recovery
    Check current key permissions and customer access.
  • INVALID_REQUEST

    Recovery
    Check field types, UUIDs, decimal strings and mutually exclusive fields.
  • SCOPE_MISMATCH

    Recovery
    Use the App and environment bound to the credential.

Related:All request and error conventions·Back to endpoint index