> 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/1.-create.md).

# 1. Create

## Record Creation Process

<mark style="color:yellow;">`POST`</mark>`{{WalletUrl}}/api/v1/campaign`&#x20;

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

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

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

<table><thead><tr><th width="162">Parameter</th><th width="98.25390625">Type</th><th width="149.453125">Compolsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the general key used to access the API.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the general identity key specific to the API client.</td></tr></tbody></table>

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

```json
{
  "Name": "External Campaign",
  "Description": "External campaign description",
  "MinimumDepositAmount": 1.00,
  "MaximumDepositAmount": 1000.00,
  "BonusType": "Fixed",
  "BonusValue": 1,
  "CampaignType": "CashBack",
  "StartDate": "2025-09-01",
  "EndDate": "2025-12-31",
  "RegionId": 1,
  "CurrencyCode": "try"
}
```

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

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

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "86f842d6-4846-4e75-bab2-34e3beed6f5b",
        "Name": "External Campaign",
        "Description": "External campaign description",
        "MinimumDepositAmount": 1.00,
        "MaximumDepositAmount": 1000.00,
        "BonusType": "Fixed",
        "BonusValue": 1,
        "CampaignType": "Bonus",
        "StartDate": "2025-09-01",
        "EndDate": "2025-12-31"
    }
}
```

{% 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>It indicates whether the transaction has failed or not. If true, an error has occurred.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>It indicates whether the transaction was successful. If true, it has been completed successfully.</td></tr><tr><td>Errors</td><td>Array</td><td>It is an array containing the details of any errors that occurred.</td></tr><tr><td>Value</td><td>Array</td><td>It contains the main data returned in the case of a successful response.</td></tr></tbody></table>

## Service Response (Value)

<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 of the campaign.</td></tr><tr><td>Name</td><td>string</td><td>The name of the campaign.</td></tr><tr><td>Description</td><td>string</td><td>Explanatory 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 amount for which the campaign is valid.</td></tr><tr><td>BonusType</td><td>string</td><td>The bonus type defined in the campaign (e.g., percentage, fixed amount).</td></tr><tr><td>BonusValue</td><td>decimal</td><td>The value of the bonus to be given.</td></tr><tr><td>CampaignType</td><td>string</td><td>The campaign type (e.g., new user, general).</td></tr><tr><td>StartDate</td><td>DateTime</td><td>The start date of the campaign.</td></tr><tr><td>EndDate</td><td>DateTime</td><td>The end date of the campaign.</td></tr><tr><td>IsActive</td><td>bool</td><td>It indicates whether the campaign is active or not.</td></tr><tr><td>MerchantId</td><td>Guid</td><td>It is the identity information of the business that defines the campaign.</td></tr><tr><td>TotalBonusGiven</td><td>decimal</td><td>The total bonus amount given so far.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>The creation date of the record.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>The last update date of the record.</td></tr></tbody></table>