Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Partner Integration.Merchants

Create merchant

Creates a new merchant.

post/partner-integration/v1/merchants

Request body

appIdstring

The id of the application associated with the merchant. Output only.

categoryCodestring required

The merchant category code (MCC) of the merchant, as a four-digit code (ISO 18245).

countryCodestring required

The merchant's domicile, the country in which the merchant is legally registered, as a two-letter code (ISO 3166-1 alpha-2).

externalIdstring

The external id of the merchant.

idstring

The id of the merchant. Output only.

namestring required

The name of the merchant. Can only have alphanumerics plus full stop, hyphen, forward slash or ampersand.

organizationNumberstring required

The organization/company/registration number of the merchant. The identification number given to a company when it is registered or incorporated.

status'PENDING' | 'VERIFIED' | 'DECLINED'

Status of the merchant.

  • PENDING: Merchant has not yet been verified.
  • VERIFIED: Merchant has been successfully verified.
  • DECLINED: Merchant verification has failed.
urlstring required

The url to the merchant's website without a path, e.g. https://example.com.

Example request

{
  "appId": "125801f6-4657-436d-b317-8f0153705fb6",
  "categoryCode": "5816",
  "countryCode": "GB",
  "external_id": "12d5c553-1558-454d-8981-6c2810138abe",
  "id": "05d5c053-1558-454d-8981-6c2810138abe",
  "name": "Example Inc.",
  "organizationNumber": "12345",
  "status": "VERIFIED",
  "url": "https://endpoint.example.com"
}

Response

A successful response.

appIdstring

The id of the application associated with the merchant. Output only.

categoryCodestring required

The merchant category code (MCC) of the merchant, as a four-digit code (ISO 18245).

countryCodestring required

The merchant's domicile, the country in which the merchant is legally registered, as a two-letter code (ISO 3166-1 alpha-2).

externalIdstring

The external id of the merchant.

idstring

The id of the merchant. Output only.

namestring required

The name of the merchant. Can only have alphanumerics plus full stop, hyphen, forward slash or ampersand.

organizationNumberstring required

The organization/company/registration number of the merchant. The identification number given to a company when it is registered or incorporated.

status'PENDING' | 'VERIFIED' | 'DECLINED'

Status of the merchant.

  • PENDING: Merchant has not yet been verified.
  • VERIFIED: Merchant has been successfully verified.
  • DECLINED: Merchant verification has failed.
urlstring required

The url to the merchant's website without a path, e.g. https://example.com.

Example response

{
  "appId": "125801f6-4657-436d-b317-8f0153705fb6",
  "categoryCode": "5816",
  "countryCode": "GB",
  "external_id": "12d5c553-1558-454d-8981-6c2810138abe",
  "id": "05d5c053-1558-454d-8981-6c2810138abe",
  "name": "Example Inc.",
  "organizationNumber": "12345",
  "status": "VERIFIED",
  "url": "https://endpoint.example.com"
}