Update a cardholder

PATCH

/cardholders/:cardholder_id

PATCH

/cardholders/:cardholder_id

curl -X PATCH https://issuing.sandbox.api.thepennyinc.com/cardholders/cardholder_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "active": true,
  "address": {
    "city": "New York",
    "country": "US",
    "line_1": "123 Main Street",
    "line_2": "Suite 200",
    "state_or_province": "NY",
    "zip_code": "10001"
  },
  "business_entity_id": "business_entity_01937c9d-3a1e-72b0-8881-3a1e2b088159",
  "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
  "cardholder_id": "cardholder_01937e19-4ebb-75bd-8250-4ebb5bd25085",
  "email": "jordan.rivera@acme.example",
  "family_name": "Rivera",
  "given_name": "Jordan",
  "phone": "+15551234567",
  "program_id": "program_019377de-7f88-7f02-894f-7f88f0294fcb",
  "spend_control_id": "spend_control_019379d9-a170-796b-867a-a17096b67a21",
  "status": "active",
  "type": "individual",
  "version": 1,
  "version_time": "2024-01-15T10:30:00Z"
}

Update a cardholder profile.

Required permissions: cardholder:update.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

cardholder_idstringRequired

Query parameters

reveal_sensitivebooleanOptionalDefaults to false

Whether to include unmasked sensitive fields in the response. Defaults to false.

Request

This endpoint expects an object.

given_namestring or nullOptional

Replacement given name for individual cardholders.

family_namestring or nullOptional

Replacement family name for individual cardholders.

business_namestring or nullOptional

Replacement business name for corporate cardholders.

emailstring or nullOptionalformat: "email"

Replacement email address.

phone_numberstring or nullOptional

Replacement phone number in E.164 format.

addressobject or nullOptional

Replacement postal address.

Response

The updated cardholder.

IndividualCardholderobject

An individual cardholder, as shown to clients through the client-facing API.

CorporateCardholderobject

A corporate cardholder, as shown to clients through the client-facing API.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error