> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/payment-orchestration-integration-document/wallet-services/7.-campaign/9.-active-campaigns.md).

# 9. Active Campaigns

## **List Active Campaigns**

<mark style="color:blue;">`GET`</mark>`{{WalletUrl}}/api/v1/campaign/active?pageNumber=1&pageSize=10&currencyCode=try&regionId=1`

{% hint style="info" %}
**Note:** To use this service, it is mandatory to include the **apikeypublic** and **apiclientpublic** parameters in the **Header**.

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

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

<table><thead><tr><th width="162">Parameter</th><th width="103.68359375">Type</th><th width="148.17578125">Compolsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>The authentication key used to provide general API access</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>The general identification key that identifies the client application</td></tr></tbody></table>

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

```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
    }
}
```

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

## **Service Response**

<table><thead><tr><th width="192">Parameter</th><th width="147.89192708333331">Type</th><th>Descripiton</th></tr></thead><tbody><tr><td>IsFailure</td><td>bool</td><td>Indicates that an error occurred during the operation; if true, there is an error</td></tr><tr><td>IsSuccess</td><td>bool</td><td>Indicates that the operation was completed successfully</td></tr><tr><td>Errors</td><td>Array</td><td>A list containing error messages generated during the service call</td></tr><tr><td>Items</td><td>Array</td><td>Contains the content returned when 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">Descripiton</th></tr></thead><tbody><tr><td>Id</td><td>Guid</td><td>The unique identifier generated by the system for the campaign</td></tr><tr><td>Name</td><td>string</td><td>The name defined for the campaign in the system</td></tr><tr><td>Description</td><td>string</td><td>A descriptive text providing information about the campaign</td></tr><tr><td>MinimumDepositAmount</td><td>decimal</td><td>The minimum deposit amount required for the campaign to be valid</td></tr><tr><td>MaximumDepositAmount</td><td>decimal</td><td>The maximum deposit limit eligible for benefiting 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 will expire</td></tr><tr><td>IsActive</td><td>bool</td><td>Indicates whether the campaign is currently active</td></tr><tr><td>MerchantId</td><td>Guid</td><td>The unique identifier of the merchant or seller defining the campaign</td></tr><tr><td>TotalBonusGiven</td><td>decimal</td><td>The total bonus amount granted so far under 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 last updated date of the record</td></tr></tbody></table>