Merchants

The following endpoints allow you to view and manage your merchant records.

Get merchants

get

Retrieves a list of merchants available for your partner account. Merchants can also be filtered based on metadata information, using query string keys meta.{key}={value}, such as ?meta.iso_id=2

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

idstringOptional

Retrieve a specific merchant by ID or merchant_id

idsstring[]Optional

Retrieve multiple merchants by their IDs

merchant_idstringOptional

Filter by merchant ID (exact match)

searchstringOptional

Search by merchant_id or associated domain hostname

is_registeredbooleanOptional

Filter by whether a domain is linked to the merchant

created_at_startstring · date-timeOptional

Filter merchants created after this date

created_at_endstring · date-timeOptional

Filter merchants created before this date

registered_at_startstring · date-timeOptional

Filter merchants registered after this date

registered_at_endstring · date-timeOptional

Filter merchants registered before this date

activated_at_startstring · date-timeOptional

Filter by domain activation date (after)

activated_at_endstring · date-timeOptional

Filter by domain activation date (before)

domain_statusstring · enumOptional

Filter by associated domain status

Possible values:

domain_idstringOptional

Filter by domain ID

domain_partner_idstringOptional

Filter by domain partner ID

pageinteger · min: 1Optional

Page number

Default: 1

limitinteger · min: 1 · max: 100Optional

Results per page

Default: 10

Responses

200

An array with all partner merchants

application/json

get/portal/merchants

GET /api/portal/merchants HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

An array with all partner merchants

{
  "meta": {
    "current_page": 1,
    "next_page": 1,
    "prev_page": 1
  },
  "result": [
    {
      "id": "text",
      "merchant_id": "text",
      "company_name": "text",
      "country": "US",
      "state": "DE",
      "city": "Wilmington",
      "address": "112 Main road",
      "postal_code": 112334,
      "iso_id": "text",
      "description": "text",
      "created_at": "2026-07-10T05:45:41.239Z",
      "registered_at": "2026-07-10T05:45:41.239Z",
      "partner_id": "text",
      "product": {
        "id": "text",
        "code": "BASE",
        "name": "text",
        "description": "text"
      },
      "price_list": {
        "id": "text",
        "code": "text",
        "name": "text"
      },
      "addons": [
        {
          "id": "text",
          "start_date": "2026-07-10T05:45:41.239Z",
          "created_at": "2026-07-10T05:45:41.239Z",
          "product": {
            "id": "text",
            "code": "text",
            "name": "text",
            "description": "text",
            "support_url": "text"
          }
        }
      ],
      "domain": {
        "id": "text",
        "hostname": "text",
        "status": "text",
        "is_active": true,
        "created_at": "2026-07-10T05:45:41.239Z",
        "activated_at": "2026-07-10T05:45:41.239Z",
        "email": "name@gmail.com",
        "source": "text"
      },
      "meta": {}
    }
  ]
}

Create merchant

post

Create a new merchant in your partner account

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Body

merchant_idstring · max: 204Required

Your merchant id

company_namestringOptional

The company name

Example: My Company Inc

countrystringOptional

ISO 3166-1 alpha-2 country code

Example: US

statestringOptional

Country state/province/region

Example: DE

citystringOptional

City

Example: Wilmington

addressstringOptional

Address

Example: 112 Main road

postal_codestringOptional

Postal code

Example: 112334

descriptionstringOptional

An optional description for this merchant

Example: Merchant one

iso_idstringOptional

Optional ISO identifier

Example: my-iso-id

productstringOptional

The default billing product code for this merchant. This will act as the default product for the domain associated with this merchant

Example: BASE

price_liststringOptional

The default billing price list code for this merchant. This will act as the default price list for the domain associated with this merchant

Example: RESELLER

metaobjectOptional

Optional key-value object containing merchant metadata

Example: {"key":"value"}

Responses

200

Merchant added to the partner account

application/json

post/portal/merchants

POST /api/portal/merchants HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "merchant_id": "text",
  "company_name": "My Company Inc",
  "country": "US",
  "state": "DE",
  "city": "Wilmington",
  "address": "112 Main road",
  "postal_code": 112334,
  "description": "Merchant one",
  "iso_id": "my-iso-id",
  "product": "BASE",
  "price_list": "RESELLER",
  "addons": [
    {
      "addon": "INSUR_01",
      "start_date": "2026-07-10T05:45:41.239Z"
    }
  ],
  "meta": {
    "key": "value"
  }
}

200

Merchant added to the partner account

{
  "result": {
    "id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr",
    "merchant_id": 1234556,
    "company_name": "My Company Inc",
    "meta": {},
    "created_at": "2026-07-10T05:45:41.239Z"
  }
}

Get merchant

get

Retrieve information about a single merchant

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

merchantIdstringRequired

Merchant id

Responses

200

The partner domain information

application/json

get/portal/merchants/{merchantId}

GET /api/portal/merchants/{merchantId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The partner domain information

{
  "result": {
    "id": "text",
    "merchant_id": "text",
    "company_name": "text",
    "country": "US",
    "state": "DE",
    "city": "Wilmington",
    "address": "112 Main road",
    "postal_code": 112334,
    "iso_id": "text",
    "description": "text",
    "created_at": "2026-07-10T05:45:41.239Z",
    "registered_at": "2026-07-10T05:45:41.239Z",
    "partner_id": "text",
    "product": {
      "id": "text",
      "code": "BASE",
      "name": "text",
      "description": "text"
    },
    "price_list": {
      "id": "text",
      "code": "text",
      "name": "text"
    },
    "addons": [
      {
        "id": "text",
        "start_date": "2026-07-10T05:45:41.239Z",
        "created_at": "2026-07-10T05:45:41.239Z",
        "product": {
          "id": "text",
          "code": "text",
          "name": "text",
          "description": "text",
          "support_url": "text"
        }
      }
    ],
    "domain": {
      "id": "text",
      "hostname": "text",
      "status": "text",
      "is_active": true,
      "created_at": "2026-07-10T05:45:41.239Z",
      "activated_at": "2026-07-10T05:45:41.239Z",
      "email": "name@gmail.com",
      "source": "text"
    },
    "meta": {}
  }
}

Update merchant

put

Update information about a merchant

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

merchantIdstringRequired

Merchant id

Body

merchant_idstringOptional

The new merchant id to use

Example: my-merchant-id

company_namestringOptional

The company legal name to use

Example: My Company Inc

countrystringOptional

ISO 3166-1 alpha-2 country code

Example: US

statestringOptional

Country state/province/region

Example: DE

citystringOptional

City

Example: Wilmington

addressstringOptional

Address

Example: 112 Main road

postal_codestringOptional

Postal code

Example: 112334

descriptionstringOptional

Optional merchant description

Example: My merchant description

metaobjectOptional

Optional key-value object containing merchant metadata

Example: {"iso_id":"id"}

domain_idstring · nullableOptional

The domain id to attach to this merchant. If set to null, it will unassign the domain from the merchant.

Example: dadcc24837ff49a2b409b288ur0tdpfd

domain_partner_idstring · nullableOptional

If set, it will assign the specified domain partner to the merchant

iso_idstring · nullableOptional

Optional ISO identifier

Example: my-iso-id

productstringOptional

The default billing product code for this merchant. This will act as the default product for the domain associated with this merchant

Example: BASE

price_liststringOptional

The default billing price list code for this merchant. This will act as the default price list for the domain associated with this merchant

Example: RESELLER

Responses

200

Acknowledgement that request was successful.

application/json

put/portal/merchants/{merchantId}

PUT /api/portal/merchants/{merchantId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "merchant_id": "my-merchant-id",
  "company_name": "My Company Inc",
  "country": "US",
  "state": "DE",
  "city": "Wilmington",
  "address": "112 Main road",
  "postal_code": 112334,
  "description": "My merchant description",
  "meta": {
    "iso_id": "id"
  },
  "domain_id": "dadcc24837ff49a2b409b288ur0tdpfd",
  "domain_partner_id": "text",
  "iso_id": "my-iso-id",
  "product": "BASE",
  "price_list": "RESELLER",
  "addons": [
    {
      "addon": "INSUR_01",
      "start_date": "2026-07-10T05:45:41.239Z"
    }
  ]
}

200

Acknowledgement that request was successful.

{
  "result": {
    "id": "text",
    "merchant_id": "text",
    "company_name": "text",
    "country": "US",
    "state": "DE",
    "city": "Wilmington",
    "address": "112 Main road",
    "postal_code": 112334,
    "iso_id": "text",
    "description": "text",
    "created_at": "2026-07-10T05:45:41.239Z",
    "registered_at": "2026-07-10T05:45:41.239Z",
    "partner_id": "text",
    "product": {
      "id": "text",
      "code": "BASE",
      "name": "text",
      "description": "text"
    },
    "price_list": {
      "id": "text",
      "code": "text",
      "name": "text"
    },
    "addons": [
      {
        "id": "text",
        "start_date": "2026-07-10T05:45:41.239Z",
        "created_at": "2026-07-10T05:45:41.239Z",
        "product": {
          "id": "text",
          "code": "text",
          "name": "text",
          "description": "text",
          "support_url": "text"
        }
      }
    ],
    "domain": {
      "id": "text",
      "hostname": "text",
      "status": "text",
      "is_active": true,
      "created_at": "2026-07-10T05:45:41.239Z",
      "activated_at": "2026-07-10T05:45:41.239Z",
      "email": "name@gmail.com",
      "source": "text"
    },
    "meta": {}
  }
}

Delete merchant

delete

Completely delete the merchant and associated domain (if any) from your partner account

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

merchantIdstringRequired

Merchant id

Responses

200

Merchant deletion confirmation

application/json

delete/portal/merchants/{merchantId}

DELETE /api/portal/merchants/{merchantId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Merchant deletion confirmation

{
  "result": {
    "deleted": true
  }
}

Bulk create merchants

post

Create up to 200 merchants in bulk with a single API call. If product, price list and addons is specified in the root body (outside merchants), they will act as default data for all items in the merchants[] array

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Body

productstringOptional

The default billing product code for this merchant. This will act as the default product for the domain associated with this merchant

Example: BASE

price_liststringOptional

The default billing price list code for this merchant. This will act as the default price list for the domain associated with this merchant

Example: RESELLER

Responses

200

Acknowledgement that request was successful.

application/json

post/portal/merchants/bulk/create

POST /api/portal/merchants/bulk/create HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "merchants": [
    "text"
  ],
  "product": "BASE",
  "price_list": "RESELLER",
  "addons": [
    {
      "addon": "INSUR_01",
      "start_date": "2026-07-10T05:45:41.239Z"
    }
  ]
}

200

Acknowledgement that request was successful.

{
  "result": {
    "created": [
      {
        "id": "7301d95285824ae2b6c99e70zkyjssgp",
        "merchant_id": "my-merchant-id",
        "created_at": "2026-07-10T05:45:41.239Z"
      }
    ],
    "failed": [
      {
        "merchant_id": "my-merchant-id",
        "error": {
          "code": "DATA.INVALID_NAME",
          "ns": "DATA",
          "message": "text",
          "status": 400,
          "data": {}
        }
      }
    ]
  }
}

Bulk delete merchants

post

Delete up to 200 merchants in bulk with a single API call

Authorizations

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Body

merchantsstring[]Required

Merchant id

Responses

200

Acknowledgement that request was successful.

application/json

post/portal/merchants/bulk/delete

POST /api/portal/merchants/bulk/delete HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "merchants": [
    "text"
  ]
}

200

Acknowledgement that request was successful.

{
  "result": {
    "deleted": [
      {
        "id": "7301d95285824ae2b6c99e70zkyjssgp",
        "merchant_id": "my-merchant-id"
      }
    ],
    "failed": [
      {
        "merchant_id": "my-merchant-id",
        "error": {
          "code": "DATA.INVALID_NAME",
          "ns": "DATA",
          "message": "text",
          "status": 400,
          "data": {}
        }
      }
    ]
  }
}

PreviousDomains NextProducts

Last updated 12 months ago