Syntch Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-09 03:02 UTC.

API reference Resellers

Create reseller

POST /api/resellers deprecated

Requires: Resellers.Resellers.Create, reseller scope.

Creates a new reseller account with the specified permissions and configuration.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a ResellerCreateDto. See the Request body section below for its fields.

Code sample language

cURL

curl -X POST "{{BASE_URL}}/api/resellers" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Phoenix Payments Group",
  "customIdentifier": "PPG-001",
  "dba": "Phoenix Payments",
  "contactDetail": {
    "primaryContactName": "Pat Reseller",
    "emailAddress": "support@phoenix-payments.example.com",
    "phone": "555-555-1000",
    "companyUrl": "https://phoenix-payments.example.com",
    "addresses": [
      {
        "address1": "1 Payments Way",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85027",
        "country": "USA",
        "isMailing": true,
        "isDefault": true
      }
    ]
  },
  "businessInfo": {
    "federalTaxId": "00-0000000",
    "currency": "USD"
  },
  "features": {
    "privateLabeling": true,
    "hostedPage": true,
    "emulator": false,
    "merchantCustomFieldConfig": true,
    "merchantBilling": true,
    "subResellers": true
  },
  "branding": {
    "brandedDomainName": "pay.phoenix-payments.example.com",
    "productName": "Phoenix Payments",
    "emailFromName": "Phoenix Payments",
    "emailFromAddress": "no-reply@phoenix-payments.example.com",
    "displayAddress": {
      "address1": "1 Payments Way",
      "city": "Phoenix",
      "state": "AZ",
      "zip": "85027",
      "country": "USA"
    },
    "supportPhone": "555-555-1000",
    "salesPhone": "555-555-1001",
    "supportEmail": "support@phoenix-payments.example.com"
  }
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "name": "Phoenix Payments Group",
  "customIdentifier": "PPG-001",
  "dba": "Phoenix Payments",
  "contactDetail": {
    "primaryContactName": "Pat Reseller",
    "emailAddress": "support@phoenix-payments.example.com",
    "phone": "555-555-1000",
    "companyUrl": "https://phoenix-payments.example.com",
    "addresses": [
      {
        "address1": "1 Payments Way",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85027",
        "country": "USA",
        "isMailing": true,
        "isDefault": true
      }
    ]
  },
  "businessInfo": {
    "federalTaxId": "00-0000000",
    "currency": "USD"
  },
  "features": {
    "privateLabeling": true,
    "hostedPage": true,
    "emulator": false,
    "merchantCustomFieldConfig": true,
    "merchantBilling": true,
    "subResellers": true
  },
  "branding": {
    "brandedDomainName": "pay.phoenix-payments.example.com",
    "productName": "Phoenix Payments",
    "emailFromName": "Phoenix Payments",
    "emailFromAddress": "no-reply@phoenix-payments.example.com",
    "displayAddress": {
      "address1": "1 Payments Way",
      "city": "Phoenix",
      "state": "AZ",
      "zip": "85027",
      "country": "USA"
    },
    "supportPhone": "555-555-1000",
    "salesPhone": "555-555-1001",
    "supportEmail": "support@phoenix-payments.example.com"
  }
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/resellers' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, ResellersApi } from '@winkpg/winkpg-api';

const api = new ResellersApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.resellersCreate({
  "name": "Phoenix Payments Group",
  "customIdentifier": "PPG-001",
  "dba": "Phoenix Payments",
  "contactDetail": {
    "primaryContactName": "Pat Reseller",
    "emailAddress": "support@phoenix-payments.example.com",
    "phone": "555-555-1000",
    "companyUrl": "https://phoenix-payments.example.com",
    "addresses": [
      {
        "address1": "1 Payments Way",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85027",
        "country": "USA",
        "isMailing": true,
        "isDefault": true
      }
    ]
  },
  "businessInfo": {
    "federalTaxId": "00-0000000",
    "currency": "USD"
  },
  "features": {
    "privateLabeling": true,
    "hostedPage": true,
    "emulator": false,
    "merchantCustomFieldConfig": true,
    "merchantBilling": true,
    "subResellers": true
  },
  "branding": {
    "brandedDomainName": "pay.phoenix-payments.example.com",
    "productName": "Phoenix Payments",
    "emailFromName": "Phoenix Payments",
    "emailFromAddress": "no-reply@phoenix-payments.example.com",
    "displayAddress": {
      "address1": "1 Payments Way",
      "city": "Phoenix",
      "state": "AZ",
      "zip": "85027",
      "country": "USA"
    },
    "supportPhone": "555-555-1000",
    "salesPhone": "555-555-1001",
    "supportEmail": "support@phoenix-payments.example.com"
  }
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/resellers', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Phoenix Payments Group",
    "customIdentifier": "PPG-001",
    "dba": "Phoenix Payments",
    "contactDetail": {
      "primaryContactName": "Pat Reseller",
      "emailAddress": "support@phoenix-payments.example.com",
      "phone": "555-555-1000",
      "companyUrl": "https://phoenix-payments.example.com",
      "addresses": [
        {
          "address1": "1 Payments Way",
          "city": "Phoenix",
          "state": "AZ",
          "zip": "85027",
          "country": "USA",
          "isMailing": true,
          "isDefault": true
        }
      ]
    },
    "businessInfo": {
      "federalTaxId": "00-0000000",
      "currency": "USD"
    },
    "features": {
      "privateLabeling": true,
      "hostedPage": true,
      "emulator": false,
      "merchantCustomFieldConfig": true,
      "merchantBilling": true,
      "subResellers": true
    },
    "branding": {
      "brandedDomainName": "pay.phoenix-payments.example.com",
      "productName": "Phoenix Payments",
      "emailFromName": "Phoenix Payments",
      "emailFromAddress": "no-reply@phoenix-payments.example.com",
      "displayAddress": {
        "address1": "1 Payments Way",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85027",
        "country": "USA"
      },
      "supportPhone": "555-555-1000",
      "salesPhone": "555-555-1001",
      "supportEmail": "support@phoenix-payments.example.com"
    }
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new ResellersApi(config);
var body = JsonSerializer.Deserialize<ResellerCreateDto>("""
    {
      "name": "Phoenix Payments Group",
      "customIdentifier": "PPG-001",
      "dba": "Phoenix Payments",
      "contactDetail": {
        "primaryContactName": "Pat Reseller",
        "emailAddress": "support@phoenix-payments.example.com",
        "phone": "555-555-1000",
        "companyUrl": "https://phoenix-payments.example.com",
        "addresses": [
          {
            "address1": "1 Payments Way",
            "city": "Phoenix",
            "state": "AZ",
            "zip": "85027",
            "country": "USA",
            "isMailing": true,
            "isDefault": true
          }
        ]
      },
      "businessInfo": {
        "federalTaxId": "00-0000000",
        "currency": "USD"
      },
      "features": {
        "privateLabeling": true,
        "hostedPage": true,
        "emulator": false,
        "merchantCustomFieldConfig": true,
        "merchantBilling": true,
        "subResellers": true
      },
      "branding": {
        "brandedDomainName": "pay.phoenix-payments.example.com",
        "productName": "Phoenix Payments",
        "emailFromName": "Phoenix Payments",
        "emailFromAddress": "no-reply@phoenix-payments.example.com",
        "displayAddress": {
          "address1": "1 Payments Way",
          "city": "Phoenix",
          "state": "AZ",
          "zip": "85027",
          "country": "USA"
        },
        "supportPhone": "555-555-1000",
        "salesPhone": "555-555-1001",
        "supportEmail": "support@phoenix-payments.example.com"
      }
    }
    """);

var result = await api.ResellersCreateAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/resellers");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "Phoenix Payments Group",
      "customIdentifier": "PPG-001",
      "dba": "Phoenix Payments",
      "contactDetail": {
        "primaryContactName": "Pat Reseller",
        "emailAddress": "support@phoenix-payments.example.com",
        "phone": "555-555-1000",
        "companyUrl": "https://phoenix-payments.example.com",
        "addresses": [
          {
            "address1": "1 Payments Way",
            "city": "Phoenix",
            "state": "AZ",
            "zip": "85027",
            "country": "USA",
            "isMailing": true,
            "isDefault": true
          }
        ]
      },
      "businessInfo": {
        "federalTaxId": "00-0000000",
        "currency": "USD"
      },
      "features": {
        "privateLabeling": true,
        "hostedPage": true,
        "emulator": false,
        "merchantCustomFieldConfig": true,
        "merchantBilling": true,
        "subResellers": true
      },
      "branding": {
        "brandedDomainName": "pay.phoenix-payments.example.com",
        "productName": "Phoenix Payments",
        "emailFromName": "Phoenix Payments",
        "emailFromAddress": "no-reply@phoenix-payments.example.com",
        "displayAddress": {
          "address1": "1 Payments Way",
          "city": "Phoenix",
          "state": "AZ",
          "zip": "85027",
          "country": "USA"
        },
        "supportPhone": "555-555-1000",
        "salesPhone": "555-555-1001",
        "supportEmail": "support@phoenix-payments.example.com"
      }
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.ResellersApi(client)
    body = winkpg_api.ResellerCreateDto.from_dict({
      "name": "Phoenix Payments Group",
      "customIdentifier": "PPG-001",
      "dba": "Phoenix Payments",
      "contactDetail": {
        "primaryContactName": "Pat Reseller",
        "emailAddress": "support@phoenix-payments.example.com",
        "phone": "555-555-1000",
        "companyUrl": "https://phoenix-payments.example.com",
        "addresses": [
          {
            "address1": "1 Payments Way",
            "city": "Phoenix",
            "state": "AZ",
            "zip": "85027",
            "country": "USA",
            "isMailing": True,
            "isDefault": True
          }
        ]
      },
      "businessInfo": {
        "federalTaxId": "00-0000000",
        "currency": "USD"
      },
      "features": {
        "privateLabeling": True,
        "hostedPage": True,
        "emulator": False,
        "merchantCustomFieldConfig": True,
        "merchantBilling": True,
        "subResellers": True
      },
      "branding": {
        "brandedDomainName": "pay.phoenix-payments.example.com",
        "productName": "Phoenix Payments",
        "emailFromName": "Phoenix Payments",
        "emailFromAddress": "no-reply@phoenix-payments.example.com",
        "displayAddress": {
          "address1": "1 Payments Way",
          "city": "Phoenix",
          "state": "AZ",
          "zip": "85027",
          "country": "USA"
        },
        "supportPhone": "555-555-1000",
        "salesPhone": "555-555-1001",
        "supportEmail": "support@phoenix-payments.example.com"
      }
    })
    result = api.resellers_create(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "name": "Phoenix Payments Group",
  "customIdentifier": "PPG-001",
  "dba": "Phoenix Payments",
  "contactDetail": {
    "primaryContactName": "Pat Reseller",
    "emailAddress": "support@phoenix-payments.example.com",
    "phone": "555-555-1000",
    "companyUrl": "https://phoenix-payments.example.com",
    "addresses": [
      {
        "address1": "1 Payments Way",
        "city": "Phoenix",
        "state": "AZ",
        "zip": "85027",
        "country": "USA",
        "isMailing": True,
        "isDefault": True
      }
    ]
  },
  "businessInfo": {
    "federalTaxId": "00-0000000",
    "currency": "USD"
  },
  "features": {
    "privateLabeling": True,
    "hostedPage": True,
    "emulator": False,
    "merchantCustomFieldConfig": True,
    "merchantBilling": True,
    "subResellers": True
  },
  "branding": {
    "brandedDomainName": "pay.phoenix-payments.example.com",
    "productName": "Phoenix Payments",
    "emailFromName": "Phoenix Payments",
    "emailFromAddress": "no-reply@phoenix-payments.example.com",
    "displayAddress": {
      "address1": "1 Payments Way",
      "city": "Phoenix",
      "state": "AZ",
      "zip": "85027",
      "country": "USA"
    },
    "supportPhone": "555-555-1000",
    "salesPhone": "555-555-1001",
    "supportEmail": "support@phoenix-payments.example.com"
  }
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/resellers",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
suppressNulls required query boolean If true, omit properties with null values.

Request body

application/json , required

Field Type Description
createdFromTemplateId required string (uuid) nullable
name required string nullablemin length 5max length 100
parentReseller required string (uuid) nullable
customIdentifier required string Conditional: When CustomIdentifier is not empty. Length: 5 to 100. nullable
dba required string Conditional: When Dba is not empty. Length: 5 to 100. nullable
isTest required boolean
code required string nullableread only
contactDetail required ResellerContactDetail Represents contact details for a reseller.
businessInfo required ResellerBusinessInfo Represents business-related information for a reseller.
features required ResellerFeatures
branding required ResellerBranding Represents branding information for a reseller, including domain, product, contact, and icon details.
billingPreferences required all of ResellerBillingPreferences Conditional: When BillingPreferences is not null.
processingDefaults required all of ResellerProcessingDefaults Portfolio-wide processing defaults applied to merchants under this reseller that have left the matching merchant-level setting unset. Nullable end to end: a reseller that never sets one changes nothing for its merchants. Conditional: When ProcessingDefaults is not null.
notes required array of EntityNote Operational notes attached to the reseller. nullable

This request body has no documented fields.

Responses

200 OK

Body: ResellerDto Each item has these fields.

Field Type Description
extraProperties required object nullableread only
id required string (uuid)
creationTime required string (date-time) The date and time when this entity was created.
creatorId required string (uuid) The ID of the user who created this entity. nullable
lastModificationTime required string (date-time) The date and time when this entity was last modified. nullable
lastModifierId required string (uuid) The ID of the user who last modified this entity. nullable
isDeleted required boolean Indicates whether this entity has been deleted.
deleterId required string (uuid) The ID of the user who deleted this entity, if it is deleted. nullable
deletionTime required string (date-time) The date and time when this entity was deleted, if it is deleted. nullable
createdFromTemplateId required string (uuid) The template this record was created from, or `null` for one started blank. Set by the create-from-template path and by the add/edit page's Load Template action when the record is saved. nullable
name required string nullable
concurrencyStamp required string nullable
tenantId required string (uuid) nullableread only
entityVersion required integer (int32) read only
parentReseller required string (uuid) nullable
customIdentifier required string nullable
dba required string nullable
code required string nullable
features required ResellerFeatures
contactDetail required ResellerContactDetail Represents contact details for a reseller.
businessInfo required ResellerBusinessInfo Represents business-related information for a reseller.
branding required ResellerBranding Represents branding information for a reseller, including domain, product, contact, and icon details.
billingPreferences required ResellerBillingPreferences Per-reseller billing configuration embedded on the Reseller aggregate root. Controls billing run scheduling, payment terms, and invoice generation preferences.
processingDefaults required all of ResellerProcessingDefaults Gets or sets the portfolio-wide processing defaults applied to merchants under this reseller that have left the matching merchant-level setting unset. `null` when the reseller sets no defaults.
isTest required boolean
legacyNumber required integer (int64) Gets the reseller's legacy numeric key, the integer identifier the v1 API addresses resellers by (its `ResellerKey`). Server-owned and stamped once at create; null on resellers written before the field existed until the v1 data migration back-fills them. nullable
notes required array of EntityNote Gets or sets operational notes attached to the reseller. nullable

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Resellers

Authentication

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.