# 8. Active Campaigns

## **List Active Campaigns**

<mark style="color:blue;">`GET`</mark>`{{WalletUrl}}/api/v1/campaign/active`

{% hint style="info" %}
**Note:** To use this service, the **apikeypublic** and **apiclientpublic** parameters must be included in the Header field.

\
[<mark style="color:green;">**WalletAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% endhint %}

**The parameters that need to be sent to the service are as follows:**

<table><thead><tr><th width="162">Parameter</th><th width="79">Type</th><th width="107">Required</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the authentication key used to provide general API access.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public identification key that defines the client application.</td></tr></tbody></table>

{% tabs %}
{% tab title="Service Reguest - JSON" %}
{% code lineNumbers="true" %}

```json
{
    "Items": [
        {
            "Id": "3ff9d71a-70cc-4be1-80bd-5db35fdb9e70",
            "Name": "fırsat101",
            "Description": "<string>",
            "MinimumDepositAmount": 500.00,
            "MaximumDepositAmount": 2000.00,
            "BonusType": "Fixed",
            "BonusValue": 1.00,
            "CampaignType": "Bonus",
            "StartDate": "2025-06-26",
            "EndDate": "2025-06-28",
            "IsActive": true,
            "MerchantId": 2071,
            "TotalBonusGiven": 0.00,
            "CreatedAt": "2025-05-01T14:14:05.151023Z",
            "UpdatedAt": null
        },
        {
            "Id": "17c87eeb-3e20-4f70-a1d8-cc801007d550",
            "Name": "fırsat100",
            "Description": "<string>",
            "MinimumDepositAmount": 500.00,
            "MaximumDepositAmount": 2000.00,
            "BonusType": "Fixed",
            "BonusValue": 1.00,
            "CampaignType": "CashBack",
            "StartDate": "2025-06-26",
            "EndDate": "2025-06-28",
            "IsActive": true,
            "MerchantId": 2071,
            "TotalBonusGiven": 0.00,
            "CreatedAt": "2025-05-01T14:13:42.169338Z",
            "UpdatedAt": null
        }
    ],
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalCount": 2,
    "HasPreviousPage": false,
    "HasNextPage": false,
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

## **Service Response**

<table><thead><tr><th width="192">Parameter</th><th width="147.89192708333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>IsFailure</td><td>bool</td><td>Indicates that an error occurred during the operation. If true, an error exists.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>Indicates that the operation was successfully completed.</td></tr><tr><td>Errors</td><td>Array</td><td>A list containing error messages that occurred during the service call.</td></tr><tr><td>Items</td><td>Array</td><td>Contains the content information returned if the service is successful.</td></tr></tbody></table>

## **Service Response** (Items)

<table><thead><tr><th width="234.05859375">Parameter</th><th width="162.38671875">Type</th><th width="348.94140625">Description</th></tr></thead><tbody><tr><td>Id</td><td>Guid</td><td>It is the unique identifier generated by the system for the campaign.</td></tr><tr><td>Name</td><td>string</td><td>It is the defined name information of the campaign on the system.</td></tr><tr><td>Description</td><td>string</td><td>It is a descriptive text that provides information about the campaign.</td></tr><tr><td>MinimumDepositAmount</td><td>decimal</td><td>It is the minimum deposit amount required for the campaign to be valid.</td></tr><tr><td>MaximumDepositAmount</td><td>decimal</td><td>It is the maximum deposit limit applicable to benefit from the campaign.</td></tr><tr><td>BonusType</td><td>string</td><td>Specifies the type of bonus (e.g., fixed amount, percentage).</td></tr><tr><td>BonusValue</td><td>decimal</td><td>The numeric value of the bonus within the specified campaign.</td></tr><tr><td>CampaignType</td><td>string</td><td>Indicates the category or usage type of the campaign.</td></tr><tr><td>StartDate</td><td>DateTime</td><td>The date when the campaign becomes active.</td></tr><tr><td>EndDate</td><td>DateTime</td><td>The date when the campaign expires.</td></tr><tr><td>IsActive</td><td>bool</td><td>The status value indicating whether the campaign is currently active or not.</td></tr><tr><td>MerchantId</td><td>Guid</td><td>The unique identifier of the business or seller defining the campaign.</td></tr><tr><td>TotalBonusGiven</td><td>decimal</td><td>The total bonus amount given so far through this campaign.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>Represents the time when the record was created.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>Indicates the date when it was last updated.</td></tr></tbody></table>