Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Merchants

Merchant:Info

Get detailed information of a specific merchant

get/v2/merchants/{merchantCode}/info

Path parameters

merchantCodestring required

The merchant id of your company starting with M.

Response

OK

codestring

The merchant id of your company starting with M.

namestring

The name of the merchant.

publicNamestring nullable

The public name of your merchant.

boardingStatus'REGISTERED' | 'ONBOARDING' | 'ACCEPTED' | 'SUSPENDED' | 'OFFBOARDED'

The status of the boarding process for this merchant.

status'ACTIVE' | 'INACTIVE'

The status of the merchant.

payoutStatus'ENABLED' | 'DISABLED'

Whether this merchant has payouts enabled.

cocstring nullable

Your Chamber of commerce registration number. This format differs per country.

vatstring nullable

Value added tax identification number (VAT identification number).

companyTypeIdstring nullable

ID of the company type. The available company types can be retrieved with the CompanyTypes Core Data API (https://developer.pay.nl/reference/get_companytypes)

countryCodestring

The country code consisting of 2 uppercase letters

contractPackageCodestring

The active contract package scramble code

currentProfileCodestring nullable

The contract profile scramble code

contractLanguagestring nullable

The language code supplied needs to be a locale in i18n format. The available languages can be retrieved with the Core Data API Languages (https://developer.pay.nl/reference/get_languages) where the contractLanguageAvailable flag is set to 'True'

contractPackagestring nullable
contactPhonestring nullable

The primary contact phone number.

contactEmailstring nullable

The primary contact email address.

establishmentLegalRegistrationNumberstring nullable

The legal registration number of the establishment.

accountManagerstring nullable

The account manager' email assigned to this merchant.

websitestring nullable

The website.

createdAtstring date-time

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring

The reference to an account or token whom created the entity

acceptedAtstring date-time nullable

The date and time at which this merchant was accepted in ISO-8601 (ATOM) notation.

suspendedAtstring date-time nullable

The date and time at which this merchant was suspended in ISO-8601 (ATOM) notation.

suspendedBystring nullable

The reference to an account or token whom suspended this merchant

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

reviewedAtstring date-time nullable

The date and time at which this merchant was reviewed by a Pay. employee.

nextReviewDatestring date-time nullable

The date and time at which this merchant will be reviewed again.

Example response

{
  "code": "M-1234-4321",
  "name": "GMS Demo Merchant",
  "publicName": "GMS Demo Merchant",
  "boardingStatus": "ACCEPTED",
  "status": "ACTIVE",
  "payoutStatus": "ENABLED",
  "coc": "12345678",
  "vat": "NL0123456789",
  "companyTypeId": "1",
  "countryCode": "NL",
  "contractPackageCode": "AG-8940-1090",
  "currentProfileCode": "CS-1234-4332",
  "contractLanguage": "nl_NL",
  "contractPackage": "Merchant by Alliance",
  "contactPhone": "+31612345678",
  "contactEmail": "sandbox@pay.nl",
  "establishmentLegalRegistrationNumber": "12345678",
  "accountManager": "accountmanager@pay.nl",
  "website": "https://www.example.com",
  "categories": [
    {
      "code": "CY-1234-4321",
      "name": "Boeken, Tijdschriften en DVD's"
    }
  ],
  "integrations": [
    {
      "code": "PL-1234-4321",
      "name": "Magento"
    }
  ],
  "clearingAccounts": [
    {
      "code": "BA-1234-4321",
      "status": "APPROVED",
      "method": "iban",
      "iban": {
        "iban": "NL91ABNA0417164300",
        "bic": "ABNANL2A",
        "owner": "Robbert van der Werf"
      }
    }
  ],
  "postalAddress": {
    "code": "CA-1234-4312",
    "streetName": "Delivery-Lane",
    "streetNumber": "70",
    "zipCode": "1234CD",
    "city": "Amsterdam",
    "countryCode": "NL"
  },
  "visitAddress": {
    "code": "CA-1234-4312",
    "streetName": "Delivery-Lane",
    "streetNumber": "70",
    "zipCode": "1234CD",
    "city": "Amsterdam",
    "countryCode": "NL"
  },
  "addresses": [
    {
      "code": "CA-1234-4312",
      "streetName": "Delivery-Lane",
      "streetNumber": "70",
      "zipCode": "1234CD",
      "city": "Amsterdam",
      "countryCode": "NL"
    }
  ],
  "contactMethods": [
    {
      "code": "CM-1234-4321",
      "type": "email",
      "value": "sandbox@pay.nl",
      "description": "The email address for the sandbox environment.",
      "public": true
    }
  ],
  "authenticationTokens": [
    {
      "code": "AT-1233-1322",
      "secret": "95c4ae0613c23435089dc0b480d98ce786a4e22a",
      "name": "token1"
    }
  ],
  "trademarks": [
    {
      "code": "TM-1234-4321",
      "type": "public_name",
      "name": "Pay.nl",
      "status": "APPROVED"
    }
  ],
  "licenses": [
    {
      "code": "AL-1234-4321",
      "name": "CustomerName",
      "language": "nl_NL",
      "documents": [
        {
          "code": "D-3713-6776",
          "type": "identification",
          "status": "APPROVED",
          "name": "Identification document",
          "description": "We need a copy of your ID. This may be an identity card or drivers license (front and back), passport or (temporary) residence permit.",
          "translations": {
            "translations": {
              "name": {
                "nl_NL": "...",
                "en_GB": "..."
              },
              "description": {
                "nl_NL": "...",
                "en_GB": "..."
              }
            }
          },
          "createdAt": "2024-06-04T08:15:00+01:00",
          "createdBy": "A-1234-4321",
          "modifiedAt": "2024-06-04T08:15:00+01:00",
          "modifiedBy": "AT-1233-1322"
        }
      ]
    }
  ],
  "services": [
    {
      "code": "SL-1234-4321",
      "secret": "95c4ae0613c23435089dc0b480d98ce786a4e22a",
      "name": "ServiceLocationName",
      "status": "ACTIVE",
      "category": {
        "code": "CY-1234-4321",
        "name": "Boeken, Tijdschriften en DVD's"
      },
      "integration": {
        "code": "PL-1234-4321",
        "name": "Magento"
      },
      "contactPhone": "+31612345678",
      "contactEmail": "sandbox@pay.nl",
      "website": "https://www.example.com",
      "urls": [
        {
          "code": "WU-1234-4321",
          "website": "https://www.example.com"
        }
      ]
    }
  ],
  "partner": [
    {
      "code": "M-1234-4321",
      "name": "GMS Demo Merchant",
      "accessToMerchant": true
    }
  ],
  "documents": [
    {
      "code": "D-3713-6776",
      "type": "identification",
      "status": "APPROVED",
      "name": "Identification document",
      "description": "We need a copy of your ID. This may be an identity card or drivers license (front and back), passport or (temporary) residence permit.",
      "translations": {
        "translations": {
          "name": {
            "nl_NL": "...",
            "en_GB": "..."
          },
          "description": {
            "nl_NL": "...",
            "en_GB": "..."
          }
        }
      },
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "AT-1233-1322"
    }
  ],
  "createdAt": "2024-06-04T08:15:00+01:00",
  "createdBy": "A-1234-4321",
  "modifiedAt": "2024-06-04T08:15:00+01:00",
  "modifiedBy": "AT-1233-1322",
  "reviewedAt": "2024-06-04T08:15:00+01:00",
  "nextReviewDate": "2024-06-04T08:15:00+01:00"
}