Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designation configurations

Get a designation configuration

This request lets you retrieve a single designation configuration. The configuration represents a relationship between a designation and a campaign and includes allowed payment frequencies.

get/v1/designation_configurations/{id}

Path parameters

idstring required
Example:MXXXXXXX

Unique identifier of the designation configuration, formatted as M[A-Z\d]{7}.

Query parameters

livemodeboolean
Example:true

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Designation configurations only exist in live mode — set this to true.

Response

On success, the API returns the designation configuration object. If the provided identifier is invalid, the request returns an error.

created_atstring required

Timestamp in ISO 8601 format, indicating when the configuration was created in UTC.

idstring required

Unique identifier for the designation configuration.

repeat'recurring' | 'one-time' | 'all' required

Indicates payment types accepted for this designation-campaign combination.

Example response

{
  "account": {
    "code": "Code-1",
    "id": "AXXXXXXX",
    "name": "Example Account"
  },
  "campaign": {
    "code": "Code-1",
    "id": "FUNXXXXXXXX",
    "name": "My Campaign"
  },
  "created_at": "2024-12-20T00:00:00.000Z",
  "designation": {
    "code": "Code-1",
    "id": "EXXXXXXX",
    "name": "My Designation"
  },
  "id": "MXXXXXXX",
  "repeat": "all"
}