9. Active Campaigns

You can list your active campaigns using the relevant service.

List Active Campaigns

GET{{WalletUrl}}/api/v1/campaign/active?pageNumber=1&pageSize=10&currencyCode=try&regionId=1

Note: To use this service, it is mandatory to include the apikeypublic and apiclientpublic parameters in the Header.

WalletAPI Address

The parameters to be sent to the service are as follows:

Parameter	Type	Compolsory	Description
apikeypublic	string	Yes	The authentication key used to provide general API access
apiclientpublic	string	Yes	The general identification key that identifies the client application

Service Request - JSON

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Items": [
            {
                "Id": "01afe72a-a2e5-4383-b370-bf13b49af0b8",
                "Name": "External Campaign 2",
                "Description": "External campaign description 2",
                "MinimumDepositAmount": 1.00,
                "MaximumDepositAmount": 1000.00,
                "BonusType": "Fixed",
                "BonusValue": 1.00,
                "CampaignType": "CashBack",
                "StartDate": "2025-09-01",
                "EndDate": "2025-12-31",
                "IsActive": true,
                "TotalBonusGiven": 0.00,
                "CreatedAt": "2025-08-20T14:50:19.136185Z",
                "UpdatedAt": null
            },
            {
                "Id": "762abb9c-f2a2-4770-a933-11411cfa8964",
                "Name": "External Campaign",
                "Description": "External campaign description",
                "MinimumDepositAmount": 1.00,
                "MaximumDepositAmount": 1000.00,
                "BonusType": "Fixed",
                "BonusValue": 1.00,
                "CampaignType": "Bonus",
                "StartDate": "2025-09-01",
                "EndDate": "2025-12-31",
                "IsActive": true,
                "TotalBonusGiven": 0.00,
                "CreatedAt": "2025-08-20T14:50:02.241666Z",
                "UpdatedAt": null
            }
        ],
        "PageNumber": 1,
        "TotalPages": 1,
        "TotalCount": 2,
        "HasPreviousPage": false,
        "HasNextPage": false
    }
}

Service Response

Parameter	Type	Descripiton
IsFailure	bool	Indicates that an error occurred during the operation; if true, there is an error
IsSuccess	bool	Indicates that the operation was completed successfully
Errors	Array	A list containing error messages generated during the service call
Items	Array	Contains the content returned when the service is successful

Service Response (Items)

Parameter	Type	Descripiton
Id	Guid	The unique identifier generated by the system for the campaign
Name	string	The name defined for the campaign in the system
Description	string	A descriptive text providing information about the campaign
MinimumDepositAmount	decimal	The minimum deposit amount required for the campaign to be valid
MaximumDepositAmount	decimal	The maximum deposit limit eligible for benefiting from the campaign
BonusType	string	Specifies the type of bonus (e.g., fixed amount, percentage)
BonusValue	decimal	The numeric value of the bonus within the specified campaign
CampaignType	string	Indicates the category or usage type of the campaign
StartDate	DateTime	The date when the campaign becomes active
EndDate	DateTime	The date when the campaign will expire
IsActive	bool	Indicates whether the campaign is currently active
MerchantId	Guid	The unique identifier of the merchant or seller defining the campaign
TotalBonusGiven	decimal	The total bonus amount granted so far under this campaign
CreatedAt	DateTime	Represents the time when the record was created
UpdatedAt	DateTime	Indicates the last updated date of the record