List Campaigns

Purpose: Retrieves a list of all available financing campaigns for a specific client. Optionally, the list can be filtered to include only campaigns applicable for a given amount.

Endpoint Details

HTTP Verb: GET
URL Segment: /v3/client/{clientId}/campaigns
OpenAPI Spec: View in Swagger UI
Notes: If the optional creditAmount parameter is provided, the list will be filtered to only include campaigns that are applicable for the given amount.

Path Parameters

This method uses a parameter passed directly in the URL path.

Field Name	Description	Type	Additional Information
`clientId`	The unique ID of the client whose campaigns are to be listed.	string ($uuid)	Required.

Query Parameters

This method uses an optional parameter passed in the URL query string for filtering.

Field Name	Description	Type	Additional Information
`creditAmount`	Filters the campaigns to only those that can be used for an order of this specific amount.	number ($double)	Optional. Non-decimal.

Request Body

No Request Body Required.

Successful Response (200 OK)

The API returns a JSON array. This array contains one or more objects, each representing a single Campaign entity upon successful retrieval.

Field Name	Description	Type
`campaignId`	The unique identifier for the campaign.	integer ($int32)
`campaignName`	The descriptive name of the campaign.	string
`monthlyCost`	The estimated monthly cost for the campaign.	number ($double)
`nominalInterest`	The nominal interest rate.	number ($double)
`effectiveInterest`	The effective interest rate (true cost of credit).	number ($double)
`administrationFee`	The recurring monthly administration fee.	number ($double)
`numberOfPayments`	The total number of payments in the payment plan.	integer ($int32)
`paymentFreeMonths`	The number of initial months with no required payments.	integer ($int32)
`totalCost`	The total cost of the credit over the full duration.	number ($double)
`setupFee`	A one-time fee charged at the start.	number ($double)
`duration`	The total duration of the campaign in months.	integer ($int32)
`interestFreeMonths`	The number of initial months where interest is waived.	integer ($int32)
`isHybridCampaign`	Flag indicating if the campaign is a hybrid type.	boolean
`creditCost`	The total cost of the credit (interest + fees).	number ($double)

Example Successful Response (200 OK)

The response is an array of campaign objects. (Note: Example values are illustrative.)

[
  {
    "campaignId": 100001,
    "campaignName": "12 Month Interest Free",
    "monthlyCost": 4583.33,
    "nominalInterest": 0.0,
    "effectiveInterest": 5.95,
    "administrationFee": 0.0,
    "numberOfPayments": 12,
    "paymentFreeMonths": 0,
    "totalCost": 55295.00,
    "setupFee": 0.0,
    "duration": 12,
    "interestFreeMonths": 12,
    "isHybridCampaign": false,
    "creditCost": 295.0
  },
  {
    "campaignId": 100002,
    "campaignName": "24 Month Low Interest",
    "monthlyCost": 2500.0,
    "nominalInterest": 8.9,
    "effectiveInterest": 12.50,
    "administrationFee": 29.0,
    "numberOfPayments": 24,
    "paymentFreeMonths": 0,
    "totalCost": 61200.00,
    "setupFee": 0.0,
    "duration": 24,
    "interestFreeMonths": 0,
    "isHybridCampaign": false,
    "creditCost": 6200.0
  }
]

Error Responses

The following HTTP status codes are explicitly documented for this method:

Status Code	Description
400 Bad Request	The request was invalid (e.g., `clientId` is not recognized, or `creditAmount` format is invalid).
500 Internal Server Error	An unexpected error occurred on the server.

List Campaigns

Endpoint Details​

Path Parameters​

Query Parameters​

Request Body​

Successful Response (200 OK)​

Example Successful Response (200 OK)​

Error Responses​