HomeKnowledge baseGovernance portalSign inStart free trial

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
Query parameters
is_registeredbooleanOptional

If specified, filters results based on whether a domain is linked to those merchants

Responses
200

An array with all partner merchants

application/json
get
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",
      "description": "text",
      "created_at": "2025-08-22T17:16:16.478Z",
      "registered_at": "2025-08-22T17:16:16.478Z",
      "partner_id": "text",
      "domain": {
        "id": "text",
        "hostname": "text",
        "status": "text",
        "is_active": true,
        "created_at": "2025-08-22T17:16:16.478Z",
        "activated_at": "2025-08-22T17:16:16.478Z",
        "email": "[email protected]",
        "source": "text"
      },
      "meta": {}
    }
  ]
}

Create merchant

post

Create a new merchant in your partner account

Authorizations
Body
merchant_idstring · max: 32Required

Your merchant id

company_namestringOptional

The company name

Example: My Company Inc
descriptionstringOptional

An optional description for this merchant

Example: Merchant one
metaobjectOptional

Optional key-value object containing merchant metadata

Example: {"iso_id":"id"}
Responses
200

Merchant added to the partner account

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

{
  "merchant_id": "text",
  "company_name": "My Company Inc",
  "description": "Merchant one",
  "meta": {
    "iso_id": "id"
  }
}
200

Merchant added to the partner account

{
  "result": {
    "id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr",
    "merchant_id": 1234556,
    "company_name": "My Company Inc",
    "meta": {},
    "created_at": "2025-08-22T17:16:16.478Z"
  }
}

Get merchant

get

Retrieve information about a single merchant

Authorizations
Path parameters
merchantIdstringRequired

Merchant id

Responses
200

The partner domain information

application/json
get
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",
    "description": "text",
    "created_at": "2025-08-22T17:16:16.478Z",
    "registered_at": "2025-08-22T17:16:16.478Z",
    "partner_id": "text",
    "domain": {
      "id": "text",
      "hostname": "text",
      "status": "text",
      "is_active": true,
      "created_at": "2025-08-22T17:16:16.478Z",
      "activated_at": "2025-08-22T17:16:16.478Z",
      "email": "[email protected]",
      "source": "text"
    },
    "meta": {}
  }
}

Update merchant

put

Update information about a merchant

Authorizations
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
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
Responses
200

Acknowledgement that request was successful.

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

{
  "merchant_id": "my-merchant-id",
  "company_name": "My Company Inc",
  "description": "My merchant description",
  "meta": {
    "iso_id": "id"
  },
  "domain_id": "dadcc24837ff49a2b409b288ur0tdpfd"
}
200

Acknowledgement that request was successful.

{
  "result": {
    "id": "text",
    "merchant_id": "text",
    "company_name": "text",
    "description": "text",
    "created_at": "2025-08-22T17:16:16.478Z",
    "registered_at": "2025-08-22T17:16:16.478Z",
    "partner_id": "text",
    "domain": {
      "id": "text",
      "hostname": "text",
      "status": "text",
      "is_active": true,
      "created_at": "2025-08-22T17:16:16.478Z",
      "activated_at": "2025-08-22T17:16:16.478Z",
      "email": "[email protected]",
      "source": "text"
    },
    "meta": {}
  }
}

Delete merchant

delete

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

Authorizations
Path parameters
merchantIdstringRequired

Merchant id

Responses
200

Merchant deletion confirmation

application/json
delete
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

Authorizations
Body
Responses
200

Acknowledgement that request was successful.

application/json
post
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: 22

{
  "merchants": [
    "text"
  ]
}
200

Acknowledgement that request was successful.

{
  "result": {
    "created": [
      {
        "id": "7301d95285824ae2b6c99e70zkyjssgp",
        "merchant_id": "my-merchant-id",
        "created_at": "2025-08-22T17:16:16.478Z"
      }
    ],
    "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
Body
merchantsstring[]Required

Merchant id

Responses
200

Acknowledgement that request was successful.

application/json
post
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": {}
        }
      }
    ]
  }
}
PreviousDomainsNextProducts

Last updated