Create White-label Integration Provider

POST 
/payments/integrations/provider/whitelabel

The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NMI. Use this endpoint to create a integration provider with the specified details. Ensure that the required information is provided in the request payload. This endpoint can be only invoked using marketplace-app token

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

altIdstringrequired

location Id / company Id based on altType

altTypestringrequired
Alt Type
Available optionslocation
uniqueNamestringrequired

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

titlestringrequired

The title or name of the integration provider.

providerstringrequired
The type of payment provider associated with the integration provider.
Available optionsauthorize-netnmi
descriptionstringrequired

A brief description providing additional information about the integration provider.

imageUrlstringrequired

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

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "uniqueName": "easy-direct",
  "title": "Title",
  "provider": {
    "AUTHORIZE_NET": "authorize-net",
    "NMI": "nmi"
  },
  "description": "Description",
  "imageUrl": "https://example.com/image.jpg"
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

The unique identifier of the integration provider.

altIdstringrequired

The altId / locationId of the integration provider.

altTypestringrequired

The altType of the integration provider.

titlestringrequired

The title or name of the integration provider.

routestringrequired

The route name associated with the integration provider.

providerstringrequired

The payment provider associated with the integration provider.

descriptionstringrequired

A brief description providing additional information about the integration provider.

imageUrlstringrequired

The URL to an image representing the integration provider.

createdAtstring<date-time>required

The timestamp when the integration provider was created.

updatedAtstring<date-time>required

The timestamp when the integration provider was last updated.

Example (auto)

{
  "_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"
}