> ## Documentation Index > Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Campaign Configurations > Retrieves detailed cashback conditions and configurations for the merchant's specific campaign. This includes maximum payable amounts, time schedules, applicable payment methods, campaign status, and cashback tiers with specific conditions and values. Useful for merchants to understand the parameters of their cashback campaigns and adjust their strategies accordingly. ## OpenAPI ````yaml /api/openapi/cashback-reference.yaml get /v2/cashbacks/configuration_campaign openapi: 3.0.3 info: title: Cashback APIs description: >- ## Introduction The Cashback API Solution offers a streamlined way for developers to manage cashback campaigns, account activations, and withdrawals, providing a seamless user experience. ### Key Features - **Campaign Management**: - **Get Cashback Campaign List**: Retrieve a list of all available cashback campaigns. - **Get Campaign Configurations**: Retrieve detailed configurations for specific cashback campaigns. - **User Cashback Management**: - **Activate User's Cashback Account**: Activate a cashback account for a user. - **Initiate Cashback Delivery**: Initiate the delivery of cashback to a user. - **Initiate Cashback Withdrawal**: Begin the process of withdrawing cashback to a user's account. - **User Information**: - **Get User List**: Retrieve a list of users with cashback accounts. This documentation provides detailed guidance for integrating these capabilities into your application. version: 2.0.0 termsOfService: https://helloclever.co/terms contact: email: support@helloclever.co servers: - url: https://api.cleverhub.co/api description: Sandbox Environment - url: https://api-merchant.helloclever.co/api description: Production Environment security: [] paths: /v2/cashbacks/configuration_campaign: get: tags: - Cashback summary: Get Campaign Configurations description: > Retrieves detailed cashback conditions and configurations for the merchant's specific campaign. This includes maximum payable amounts, time schedules, applicable payment methods, campaign status, and cashback tiers with specific conditions and values. Useful for merchants to understand the parameters of their cashback campaigns and adjust their strategies accordingly. parameters: - in: query name: page schema: type: integer default: 1 description: >- The page number to retrieve in the paginated response. Defaults to 1 if not specified. example: 1 - in: query name: per_page schema: type: integer default: 10 description: >- The number of campaigns to display per page. Defaults to 10 if not specified. example: 10 - in: query name: status schema: type: string description: Filter the campaigns by their status. example: active responses: '200': description: >- A successful response containing cashback conditions and configurations. content: application/json: schema: type: object properties: merchant_id: type: integer description: >- The unique identifier of the merchant associated with the campaign. example: 123 site_id: type: string description: >- The unique identifier of the site where the campaign is active. example: site_123 campaign_id: type: string description: The unique identifier of the cashback campaign. example: campaign_456 name: type: string description: The name of the cashback campaign. example: Holiday Cashback Campaign max_payable_cashback_amount: type: object description: Specifies maximum cashback amounts that can be paid out. properties: in_whole_campaign_duration: type: number nullable: true description: >- The maximum total cashback amount available for the entire campaign duration. Null indicates unlimited cashback. example: null per_transaction: type: number nullable: true description: >- The maximum cashback amount that can be awarded per transaction. Null indicates no per-transaction limit. example: 50 max_cashback_amount_receivable_per_user: type: number nullable: true description: >- The maximum cashback amount each user can receive throughout the entire campaign. Null indicates no per-user limit. example: 200 time_schedule_response: type: object description: >- The time schedule for the campaign, including start and end times, and any repeating schedule. properties: start_time: type: string format: date-time description: The start time of the campaign in ISO 8601 format. example: '2024-11-05T16:20:00.000Z' end_time: type: string format: date-time description: The end time of the campaign in ISO 8601 format. example: '2024-12-05T16:20:00.000Z' start_time_repeat: type: string nullable: true description: >- The start time for any repeating cycles within the campaign in "HH:mm:ss" format. Null if there is no repeating schedule. example: null end_time_repeat: type: string nullable: true description: >- The end time for any repeating cycles within the campaign in "HH:mm:ss" format. Null if there is no repeating schedule. example: null repeat_days: type: array items: type: string nullable: true description: >- An array of days of the week on which the campaign repeats. Null if the campaign does not repeat. example: - Mon - Wed - Fri payment_methods: type: array description: >- A list of payment methods that are valid for the cashback program. items: type: string example: - pay_id - pay_to - card status: type: string description: The current status of the campaign. example: active tiers: type: array description: >- A list of cashback tiers within the campaign, each defining specific cashback conditions and rewards. items: type: object properties: cashback_type: type: string description: >- The type of cashback ('percentage' or 'fixed') offered in this tier. example: percentage cashback_value: type: number description: >- The cashback value for this tier. For 'percentage' type, this represents a percentage (e.g., 10.0 for 10%). For 'fixed', this is a fixed monetary amount. example: 10 absolute_type: type: string description: >- The condition type that must be met to qualify for cashback in this tier. example: min_order absolute_value: type: number description: >- The absolute value required to meet the cashback condition specified by 'absolute_type'. example: 100 '400': description: Bad Request '401': description: Unauthorized security: - app-id: [] secret-key: [] components: securitySchemes: app-id: type: apiKey in: header name: app-id description: | A unique identifier assigned to each application. secret-key: type: apiKey in: header name: secret-key description: | A secure token associated with the `app-id`. ```` ## Related topics - [Drive Loyalty with Cashback Campaigns](/developer-reference/api-use-cases/drive-loyalty-with-cashback-campaigns.md) - [Get Cashback Campaign List](/api/cashback/get-cashback-campaign-list.md) - [Cashback API Overview](/api/cashback/overview.md)