v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB

Cardholder

Update Cardholder

This endpoint supports partial updates to cardholder information, depending on the card BINs. For BB bins email only. For BZ BINs: email and phone number For other BINs, phone number only. Updates apply only to cards created after the change. Existing cards are not affected.<br> Updates are not available for the CORPORATE_MANAGED cardholderTier.

patch/open-api/v3/cardholders/{id}

Path parameters

idstring required

The ID of the cardholder.

Request body

accountIdstring uuid required

The UUID of the account.

emailstring

User’s email address. Example: user@example.com

phoneCountryCodestring

Country code of the cardholder’s mobile number, numbers only, no "+", length ≤ 3. Example: 86. Required for 493193 BIN cards.

phoneNumberstring

Mobile phone number of the cardholder without the country code, length ≤ 15. Example: 13800138000. Required for 493193 BIN cards.

binIdstring

The Id of the bin.

Example request

{
  "address": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "New York",
    "country": "US",
    "postalCode": "10001"
  }
}

Response

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter",
  "data": {
    "address": {
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 4B",
      "city": "New York",
      "country": "US",
      "postalCode": "10001"
    }
  }
}