> ## Documentation Index > Fetch the complete documentation index at: https://playcamp.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Redeem Coupon > Redeems the coupon and returns reward information. Usage is recorded in DB and webhook is sent. ## OpenAPI ````yaml /api_docs/openapi.yaml post /v1/server/coupons/redeem openapi: 3.0.3 info: title: PlayCamp SDK API description: > PlayCamp SDK API - Game analytics and creator campaign integration API ## Required Integration APIs (Server API) 3 APIs that must be integrated for campaign operation: - `POST /v1/server/sponsors` - User boosts a creator - `POST /v1/server/coupons/validate` - Validate coupon code - `POST /v1/server/payments` - Register in-game payment ## Authentication - **Client API**: `Authorization: Bearer {CLIENT_KEY_ID}:{CLIENT_SECRET}` - **Server API**: `Authorization: Bearer {SERVER_KEY_ID}:{SERVER_SECRET}` ## Servers - **Live**: https://sdk-api.playcamp.io (Production data) - **Sandbox**: https://sandbox-sdk-api.playcamp.io (Test data) ## Key Types - **Client Key**: For game client (read-only - campaign, creator queries) - **Server Key**: For game server (read/write - coupon redemption, payment registration, etc.) ## Test Mode (isTest) Before campaign launch, use `isTest: true` parameter to test API integration. - Request parameter validation is performed identically to production - Returns mock data without recording to actual DB - Verify integration in Sandbox environment before campaign launch, then remove `isTest` parameter for actual campaign version: 1.1.0 contact: name: PlayCamp Support servers: - url: https://sdk-api.playcamp.io description: Live Server - url: https://sandbox-sdk-api.playcamp.io description: Sandbox Server - url: http://localhost:3001 description: Local Live Server - url: http://localhost:3003 description: Local Sandbox Server security: [] tags: - name: Health description: Server health check - name: Client Campaign description: Campaign queries (Client API) - name: Client Creator description: Creator queries (Client API) - name: Client Coupon description: Coupon validation (Client API) - name: Client Sponsor description: Boost status queries — Sponsor API (Client API) - name: Server Campaign description: Campaign queries (Server API) - name: Server Creator description: Creator queries (Server API) - name: Server Coupon description: Coupon management (Server API) - name: Server Sponsor description: Boost management — Sponsor API (Server API) - name: Server Payment description: Payment management (Server API) - name: Server Playtime description: Playtime session management (Server API) - name: Server Webhook description: Webhook management (Server API) - name: Server Webview description: WebView management (Server API) paths: /v1/server/coupons/redeem: post: tags: - Server Coupon summary: Redeem Coupon description: | Redeems the coupon and returns reward information. Usage is recorded in DB and webhook is sent. operationId: serverRedeemCoupon requestBody: required: true content: application/json: schema: type: object required: - couponCode - userId properties: couponCode: type: string description: Coupon code userId: type: string description: User ID gameUserUuid: type: string format: uuid description: In-game user UUID (optional) callbackId: type: string description: >- Webhook tracking ID (included in webhook events triggered by this request) isTest: type: boolean default: false description: Test mode (does not create actual data) responses: '200': description: Success content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/RedeemResult' '400': description: | Invalid coupon or cannot be used - `COUPON_NOT_FOUND`: Non-existent coupon code - `COUPON_INACTIVE`: Deactivated coupon - `COUPON_NOT_YET_VALID`: Before valid period - `COUPON_EXPIRED`: Expired coupon - `USER_CODE_LIMIT`: User code usage limit exceeded - `USER_PACKAGE_LIMIT`: User package usage limit exceeded - `TOTAL_USAGE_LIMIT`: Total usage limit exceeded content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 400 error: Bad Request message: Coupon usage limit exceeded code: USER_CODE_LIMIT '401': $ref: '#/components/responses/Unauthorized' security: - ServerAuth: [] components: schemas: RedeemResult: type: object description: Coupon redemption result properties: success: type: boolean description: Whether redemption was successful usageId: type: integer description: Usage record ID couponCode: type: string description: The coupon code (uppercase) userId: type: string description: User ID who redeemed packageId: type: integer description: Coupon package ID itemName: type: object description: Multilingual item name additionalProperties: type: string quantity: type: integer description: Item quantity creatorKey: type: string description: Creator key associated with the coupon redeemedAt: type: string format: date-time description: Redemption timestamp errorCode: type: string description: 'Error code (only when success: false)' errorMessage: type: string description: 'Error message (only when success: false)' Error: type: object required: - status - error - message - code properties: status: type: integer description: HTTP status code error: type: string description: HTTP status name message: type: string description: Detailed error message code: type: string description: | Error codes: - `VALIDATION_ERROR`: Request parameter validation failed - `BAD_REQUEST`: Invalid request - `UNAUTHORIZED`: Authentication failed (API key error) - `FORBIDDEN`: Access denied - `NOT_FOUND`: Resource not found - `CONFLICT`: Duplicate resource (already exists) - `INTERNAL_ERROR`: Internal server error details: type: array description: Validation error details (for VALIDATION_ERROR) items: type: object properties: path: type: string message: type: string example: status: 404 error: Not Found message: 'Payment not found: txn-12345' code: NOT_FOUND responses: Unauthorized: description: Authentication failed (API key error) content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 401 error: Unauthorized message: Invalid API key code: UNAUTHORIZED securitySchemes: ServerAuth: type: http scheme: bearer description: 'Server API Key (format: {keyId}:{secret})' ````