SIsilverflow
Enrollments

Update Enrollment [EXPERIMENTAL]

This operation starts the update process of an Enrollment. The Enrollment entity will have pending as enrollmentStatus. Confirmed and successful updates have enrolled as enrollmentStatus. This operation is currently only supported by AMEX Sponsored Merchant Enrollments.

Requires enrollments:Update permission.

patch/enrollments/{enrollmentKey}

Request

Path parameters

enrollmentKeystring required

Uniquely identifies an Enrollment.

Request body

type'amex_sm' required

Type of the enrollment.

  • amex_sm - American Express, Sponsored Merchant (Please reach out to your technical account manager to enable your production access)
mccstring

The Merchant category.

doingBusinessAsNamestring

The Seller's business name that appears on the store front and/or Customer receipts, commonly referred to as the Doing Business As (DBA) name. If the name is more than 60 characters, use a proper and meaningful abbreviation, when possible. Do not truncate.

phoneNumberstring

The phone number for the Seller's physical location. Phone numbers must contain the international telephone country code.

legalNamestring

The Seller's legal name. If the name is more than 60 characters, use proper and meaningful abbreviation, when possible. Do not truncate.

businessRegistrationNumberstring nullable

The Seller's Tax Identification Number or their functional equivalents.

Example request

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

Response

The updated Enrollment

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.