Skip to main content
POST
/
payments
/
integrations
/
provider
/
whitelabel
Create White-label Integration Provider
curl --request POST \
  --url https://services.leadconnectorhq.com/payments/integrations/provider/whitelabel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "uniqueName": "easy-direct",
  "title": "Title",
  "provider": {
    "AUTHORIZE_NET": "authorize-net",
    "NMI": "nmi"
  },
  "description": "Description",
  "imageUrl": "https://example.com/image.jpg"
}
'
{
  "_id": "65cb47dda50f4f13ced4b870",
  "altId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "altType": "location",
  "title": "Example",
  "route": "epd",
  "provider": "nmi",
  "description": "Lorem",
  "imageUrl": "https://example.com/assets/pmd/img/payments/nmi-logo.webp",
  "createdAt": "2024-02-13T10:43:41.026Z",
  "updatedAt": "2024-02-13T10:43:41.026Z"
}

Authorizations

​
Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Body

application/json
​
altId
string
required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

​
uniqueName
string
required

A unique name given to the integration provider, uniqueName must start and end with a character. Only lowercase characters and hyphens (-) are supported

Example:

"easy-direct"

​
title
string
required

The title or name of the integration provider.

Example:

"Title"

​
provider
enum<string>
required

The type of payment provider associated with the integration provider.

Available options:
authorize-net,
nmi
Example:
{
  "AUTHORIZE_NET": "authorize-net",
  "NMI": "nmi"
}
​
description
string
required

A brief description providing additional information about the integration provider.

Example:

"Description"

​
imageUrl
string
required

The URL to an image representing the integration provider. The imageUrl should start with "https://" and ensure that this URL is publicly accessible.

Example:

"https://example.com/image.jpg"

Response

Successful response

​
_id
string
required

The unique identifier of the integration provider.

Example:

"65cb47dda50f4f13ced4b870"

​
altId
string
required

The altId / locationId of the integration provider.

Example:

"Z4Bxl8J4SaPEPLq9IQ8g"

​
altType
string
required

The altType of the integration provider.

Example:

"location"

​
title
string
required

The title or name of the integration provider.

Example:

"Example"

​
route
string
required

The route name associated with the integration provider.

Example:

"epd"

​
provider
string
required

The payment provider associated with the integration provider.

Example:

"nmi"

​
description
string
required

A brief description providing additional information about the integration provider.

Example:

"Lorem"

​
imageUrl
string
required

The URL to an image representing the integration provider.

Example:

"https://example.com/assets/pmd/img/payments/nmi-logo.webp"

​
createdAt
string<date-time>
required

The timestamp when the integration provider was created.

Example:

"2024-02-13T10:43:41.026Z"

​
updatedAt
string<date-time>
required

The timestamp when the integration provider was last updated.

Example:

"2024-02-13T10:43:41.026Z"

Last modified on March 4, 2026