Update Contact Details

PATCH 
/api/accounts/:accountId/contact-details

This endpoint sets or updates the contact details (email and phone) for the account. The contact details are used to send notifications to the cardholder, such as for 3DSecure and one time passwords.

Request

Path Parameters

accountId stringrequired

AccountId for the contact details

application/json

Body

required

email

object

emailAddress stringrequired

Email address

phone

object

phoneNumber stringrequired

Phone number

Responses

200

application/json

Schema

Schema

email

object

accountId stringrequired

createdAt date-timerequired

modifiedAt date-timerequired

emailAddress stringrequired

phone

object

accountId stringrequired

createdAt date-timerequired

modifiedAt date-timerequired

phoneNumber stringrequired

Example (from schema)

{
  "email": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2024-11-15T17:24:12.456Z",
    "modifiedAt": "2024-11-15T17:24:12.456Z",
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2024-11-15T17:24:12.456Z",
    "modifiedAt": "2024-11-15T17:24:12.456Z",
    "phoneNumber": "+1234567890"
  }
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

API caller is not allowed to perform the action

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...