3. Get by Name

This service is used to display existing record details using the specified name information.

Get Record Information by Name

GET{{WalletUrl}}/api/v1/campaign/by/name?Name=test

Note: To use this service, the apikeypublic and apiclientpublic parameters must be added to the Header field.

WalletAPI Address

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

Parameter	Type	Required	Description
apikeypublic	string	Yes	It is the authentication key used to provide general API access.
apiclientpublic	string	Yes	It is the public identification key that defines the client application.

Service Reguest - JSON

{
    "Value": {
        "Id": "44e93e35-d427-4ae9-a11c-b122447b6ac4",
        "Name": "test",
        "Description": "<string>",
        "MinimumDepositAmount": 100.00,
        "MaximumDepositAmount": 102.00,
        "BonusType": "Fixed",
        "BonusValue": 1.00,
        "CampaignType": "CashBack",
        "StartDate": "2025-09-25",
        "EndDate": "2025-09-27",
        "IsActive": true,
        "MerchantId": 2071,
        "TotalBonusGiven": 0.00,
        "CreatedAt": "2025-04-30T14:17:27.331977Z",
        "UpdatedAt": "2025-05-01T00:17:55.993342Z"
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Service Response

Parameter	Type	Description
IsFailure	bool	Indicates that an error occurred during the process. If true, an error exists.
IsSuccess	bool	Indicates that the operation was successfully completed.
Errors	Array	A list containing error messages that occurred during the service call.
Value	Array	Contains the content information returned if the service is successful.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier generated by the system for the campaign.
Name	string	It is the defined name information of the campaign on the system.
Description	string	It is a descriptive text that provides information about the campaign.
MinimumDepositAmount	decimal	It is the minimum deposit amount required for the campaign to be valid.
MaximumDepositAmount	decimal	It is the maximum deposit limit applicable to benefit 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 to which the campaign belongs.
StartDate	DateTime	It is the date on which the campaign takes effect.
EndDate	DateTime	Indicates the date on which the campaign's validity will end.
IsActive	bool	It is the status value indicating whether the campaign is currently active.
MerchantId	Guid	It is the unique identifier of the business or seller defining the campaign.
TotalBonusGiven	decimal	It is the total bonus amount given so far through this campaign.
CreatedAt	DateTime	Represents the time when the record was created.
UpdatedAt	DateTime	Represents the time when the record was created.