KAkalixa

Registers a new company related to a merchant.

Registers a new company related to a merchant.

post/related-companies

Request

  • Base URL
    https://api.test.kalixa.com/payment-service/v6
  • URL
    https://api.test.kalixa.com/payment-service/v6/related-companies
  • Auth
    HTTP basic

Request body

rolesstring[] required

A list of roles that this company takes in the context of this application.

namestring required

The legal company name. Used for screening purposes by the PXP Financial Risk Team.

taxNumberstring required

The taxpayer Identification Number (TIN) of the company. Used for screening purposes by the PXP Financial Risk Team.

incorporationDatestring required

The exact starting date of the corporation, as it appears on the company registry of the country of incorporation. Used for screening purposes by the PXP Financial Risk Team.

incorporationNumberstring required

The federal number assigned to the business in the company registry at the time of incorporation. Used for screening purposes by the PXP Financial Risk Team.

shareOrOwnershipPercentagenumber

A percentage amount that indicates the ownership participation of the person. Used for screening purposes by the PXP Financial Risk Team.

merchantIdstring required

The id of the merchant to which this company relates to. Used for associating the company with the merchant.

Example request

{
  "name": "Master Universe Inc.",
  "incorporationAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "taxNumber": "ATU99999978",
  "incorporationDate": "2020-12-09T09:46:18.646Z",
  "incorporationNumber": "U4567UP1234234",
  "shareOrOwnershipPercentage": 25,
  "merchantId": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
}

Response

Successful operation

idstring

The server-generated id of the company which was registered or returned. Used for identifying the company in other methods e.g. getRelatedCompany.

rolesstring[]

A list of roles that this company holds.

namestring

The legal company name. Used for screening purposes by the PXP Financial Risk Team.

taxNumberstring

The taxpayer Identification Number (TIN) of the company. Used for screening purposes by the PXP Financial Risk Team.

incorporationDatestring

The exact starting date of the corporation, as it appears on the company registry of the country of incorporation. Used for screening purposes by the PXP Financial Risk Team.

incorporationNumberstring

The federal number assigned to the business in the company registry at the time of incorporation. Used for screening purposes by the PXP Financial Risk Team.

shareOrOwnershipPercentagenumber

A percentage amount that indicates the ownership participation of the person. Used for screening purposes by the PXP Financial Risk Team.

Example response

{
  "id": "b7b8d27a-35b0-488c-9ad0-2be7697a533a",
  "name": "Master Universe Inc.",
  "incorporationAddress": {
    "street": "Tottenhamroad 123",
    "city": "London",
    "postalCode": "AHC 334",
    "country": "GB"
  },
  "taxNumber": "ATU99999978",
  "incorporationDate": "2020-12-09T09:46:18.646Z",
  "incorporationNumber": "U4567UP1234234",
  "shareOrOwnershipPercentage": 25,
  "merchant": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "documents": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.