Skip to main content
Documentation Powered by Redocly

Managed Companies API requests specification (1.0)

Download OpenAPI specification:Download

Managed Companies API requests specification

Managed Companies

Manage companies

Create a new managed company

Create a new managed company

header Parameters
terminal-secret
required
string <uuid>
Example: 3858f642-e92f-431c-9d38-46d15efb7fba
terminal-id
required
string
Example: 62b48adf6ba2cd6a040b1eec
Request Body schema: application/json
name
required
string (Name)

The name of the company

tradingName
string (TradingName)

The trading name of the company

type
required
string (type)
Enum: "sole_trader" "company"
required
string or string (Identifier)
countryCode
required
string (CountryCode)
industry
required
string (Industry)
publicWebsite
string <uri> (PublicWebsite)
publicEmail
string <email> (PublicEmail)
privacyPolicy
string (PrivacyPolicy)
termsOfService
string (TermsOfService)
required
object (CreateAddress)
required
object (CreateAddress)
required
object (CreateContact)
object (CreateBankAccount)
alias
string (Alias) <= 18 characters

The name of the company which is displayed in the payment page. Due to bank restrictions, the name should be less than 18 characters long. If not provided, the Trading name cut to 18 characters will be used.

Responses

Request samples

Content type
application/json
{
  • "name": "Example company Name",
  • "tradingName": "Example trading name",
  • "type": "company",
  • "identifier": "AB000000",
  • "countryCode": "GB",
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "termsOfService": "string",
  • "address": {
    },
  • "tradingAddress": {
    },
  • "contact": {
    },
  • "bankAccount": {
    },
  • "alias": "Example company Name"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "62b48adf6ba2cd6a040b1eec",
  • "name": "Example company Name",
  • "tradingName": "Example trading name",
  • "type": "company",
  • "identifier": "AB000000",
  • "countryCode": "GB",
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "termsOfService": "string",
  • "address": {
    },
  • "tradingAddress": {
    },
  • "contact": {
    },
  • "bankAccounts": [
    ],
  • "integrations": [],
  • "alias": "Example company Name",
  • "verificationStatus": "verified",
  • "isActive": "active",
  • "isSandbox": false,
  • "defaultBankAccount": {
    }
}

Get a list of managed companies

Get a list of managed companies

query Parameters
page
integer
Default: 1
Example: page=4

Current page number

limit
integer
Default: 25
Example: limit=10

Number of items per page

header Parameters
terminal-secret
required
string <uuid>
Example: 3858f642-e92f-431c-9d38-46d15efb7fba
terminal-id
required
string
Example: 62b48adf6ba2cd6a040b1eec

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": {
    }
}

Get a managed company by ID

Get a managed company by ID

path Parameters
companyId
required
string
Example: 62b48adf6ba2cd6a040b1eec

The ID of the company

header Parameters
terminal-secret
required
string <uuid>
Example: 3858f642-e92f-431c-9d38-46d15efb7fba
terminal-id
required
string
Example: 62b48adf6ba2cd6a040b1eec

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "62b48adf6ba2cd6a040b1eec",
  • "name": "Example company Name",
  • "tradingName": "Example trading name",
  • "type": "company",
  • "identifier": "AB000000",
  • "countryCode": "GB",
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "termsOfService": "string",
  • "address": {
    },
  • "tradingAddress": {
    },
  • "contact": {
    },
  • "bankAccounts": [
    ],
  • "integrations": [],
  • "alias": "Example company Name",
  • "verificationStatus": "verified",
  • "isActive": "active",
  • "isSandbox": false,
  • "defaultBankAccount": {
    }
}

Update a managed company by ID

Update a managed company by ID

path Parameters
companyId
required
string
Example: 62b48adf6ba2cd6a040b1eec

The ID of the company

header Parameters
terminal-secret
required
string <uuid>
Example: 3858f642-e92f-431c-9d38-46d15efb7fba
terminal-id
required
string
Example: 62b48adf6ba2cd6a040b1eec
Request Body schema: application/json
industry
string (Industry)
publicWebsite
string <uri> (PublicWebsite)
publicEmail
string <email> (PublicEmail)
privacyPolicy
string (PrivacyPolicy)
alias
string (Alias) <= 18 characters

The name of the company which is displayed in the payment page. Due to bank restrictions, the name should be less than 18 characters long. If not provided, the Trading name cut to 18 characters will be used.

termsOfService
string (TermsOfService)
object (CreateAddress)
object (CreateContact)

Responses

Request samples

Content type
application/json
{
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "alias": "Example company Name",
  • "termsOfService": "string",
  • "tradingAddress": {
    },
  • "contact": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "62b48adf6ba2cd6a040b1eec",
  • "name": "Example company Name",
  • "tradingName": "Example trading name",
  • "type": "company",
  • "identifier": "AB000000",
  • "countryCode": "GB",
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "termsOfService": "string",
  • "address": {
    },
  • "tradingAddress": {
    },
  • "contact": {
    },
  • "bankAccounts": [
    ],
  • "integrations": [],
  • "alias": "Example company Name",
  • "verificationStatus": "verified",
  • "isActive": "active",
  • "isSandbox": false,
  • "defaultBankAccount": {
    }
}

Toggle managed company access to service

Toggle managed company access to the service by changing status to banned or active

path Parameters
companyId
required
string
Example: 62b48adf6ba2cd6a040b1eec

The ID of the company

header Parameters
terminal-secret
required
string <uuid>
Example: 3858f642-e92f-431c-9d38-46d15efb7fba
terminal-id
required
string
Example: 62b48adf6ba2cd6a040b1eec

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "62b48adf6ba2cd6a040b1eec",
  • "name": "Example company Name",
  • "tradingName": "Example trading name",
  • "type": "company",
  • "identifier": "AB000000",
  • "countryCode": "GB",
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "termsOfService": "string",
  • "address": {
    },
  • "tradingAddress": {
    },
  • "contact": {
    },
  • "bankAccounts": [
    ],
  • "integrations": [],
  • "alias": "Example company Name",
  • "verificationStatus": "verified",
  • "isActive": "active",
  • "isSandbox": false,
  • "defaultBankAccount": {
    }
}

Webhooks

Webhooks API requests specification

Company verification status update Webhook

Webhook notification about company verification status update. Webhook will be sent to the partner's webhook URL address, when the company verification status is updated.

Request Body schema: application/json

Webhook payload

scope
string
Value: "managed-companies"

The scope of the webhook

event_name
string
Value: "verification-status-update"

event_name

id
string

The ID of the company

name
string (Name)

The name of the company

tradingName
string (TradingName)

The trading name of the company

type
string (type)
Enum: "sole_trader" "company"
string or string (Identifier)
countryCode
string (CountryCode)
industry
string (Industry)
publicWebsite
string <uri> (PublicWebsite)
publicEmail
string <email> (PublicEmail)
privacyPolicy
string (PrivacyPolicy)
termsOfService
string (TermsOfService)
object (GetAddress)
object (GetAddress)
object (GetContact)
Array of objects (BankAccountData) [ items ]
Array of objects (IntegrationData) [ items ]
alias
string (Alias) <= 18 characters

The name of the company which is displayed in the payment page. Due to bank restrictions, the name should be less than 18 characters long. If not provided, the Trading name cut to 18 characters will be used.

verified (string) or pending_verification (string) or rejected_with_retry_allowed (string) or started_verification (string) or manual_review_required (string) or rejected (string) (VerificationStatus)

The verification status of the company

isActive
string (Status)
Enum: "active" "banned"

Whether the company has access to the system

isSandbox
boolean (IsSandbox)

Whether the company is sandbox

object (BankAccountData)

Responses

Request samples

Content type
application/json
{
  • "id": "62b48adf6ba2cd6a040b1eec",
  • "name": "Example company Name",
  • "tradingName": "Example trading name",
  • "type": "company",
  • "identifier": "AB000000",
  • "countryCode": "GB",
  • "industry": "Beauty and Personal Care / Health and beauty",
  • "publicWebsite": "https://example.com",
  • "publicEmail": "example@mail.com",
  • "privacyPolicy": "string",
  • "termsOfService": "string",
  • "address": {
    },
  • "tradingAddress": {
    },
  • "contact": {
    },
  • "bankAccounts": [
    ],
  • "integrations": [],
  • "alias": "Example company Name",
  • "verificationStatus": "verified",
  • "isActive": "active",
  • "isSandbox": false,
  • "defaultBankAccount": {
    }
}