Enrollments

Create Enrollment [EXPERIMENTAL]

This operation creates a new Enrollment for the specified type and variables. Enrollment is an asynchronous process. It may take some time to complete depending on the enrollment type.

Requires enrollments:Create permission.

post/enrollments

Request

Request body

OR
OR
OR
OR

Example request

{
  "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
  "mid": "UO2344SDDAUOGS",
  "signer": {
    "address": {
      "line1": "Entrada 300",
      "line2": "Entrada 300",
      "city": "Amsterdam-Duivendrecht",
      "postalCode": "1114 AA",
      "countryCode": {
        "alpha3": "NLD"
      },
      "stateOrProvince": "Noord-Holland"
    }
  }
}

Response

The created enrollment with pending status

OR
OR
OR
OR
OR

Example response

{
  "key": "enr-1UF2NafdfrdPMf2XrS2",
  "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
  "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
  "enrollmentDetail": {
    "sellerCurrency": "EUR",
    "mid": "UO2344SDDAUOGS",
    "registeredAddress": {
      "line1": "Entrada 300",
      "line2": "Entrada 300",
      "city": "Amsterdam-Duivendrecht",
      "postalCode": "1114 AA",
      "countryCode": {
        "alpha3": "NLD",
        "alpha2": "NL",
        "numeric": "528"
      },
      "stateOrProvince": "Noord-Holland"
    },
    "signer": {
      "address": {
        "line1": "Entrada 300",
        "line2": "Entrada 300",
        "city": "Amsterdam-Duivendrecht",
        "postalCode": "1114 AA",
        "countryCode": {
          "alpha3": "NLD",
          "alpha2": "NL",
          "numeric": "528"
        },
        "stateOrProvince": "Noord-Holland"
      }
    }
  }
}

Changes

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