Перейти к содержимому
API-документация
Справочник APIДержатели

Найти держателя

GET/api/partner/v1/cardholders/{external_id}
Scope
cards:read

Возвращает держателя, зарегистрированного под вашим external_id. Используйте, чтобы проверить перед выпуском, зарегистрирован ли человек.

Наш id держателя здесь тоже находится. Это совместимость, а не контракт: POST /cardholders дедуплицирует по external_id, поэтому хранить нужно его.

Параметры пути

ПараметрТипОбяз.Описание
external_idstringдаВаш идентификатор человека. Наш id этого держателя здесь тоже находится. (до 128 символов)

Пример запроса

TS=$(date +%s)
SIG=$(printf '%s\n%s\n%s\n%s' "$TS" "GET" "/api/partner/v1/cardholders/cust-42" "" \
  | openssl dgst -sha256 -hmac "$PP_SECRET" -hex | awk '{print $NF}')

curl -sS -X GET "https://api.plativputi.com/api/partner/v1/cardholders/cust-42" \
  -H "X-Key-Id: $PP_KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"
const res = await pp("GET", "/cardholders/cust-42");
res = pp("GET", "/cardholders/cust-42")
$res = pp('GET', '/cardholders/cust-42');

pp() — функция-обёртка с подписью из раздела Аутентификация и подпись.

Ответ

200 OK — CardholderDTO

ПолеТипОбяз.Описание
created_atstringдаКогда держатель зарегистрирован, UTC
emailstringдаКонтактный адрес
external_idstringдаВаш идентификатор, возвращается как есть. Его вы передаёте в holder_external_id при выпуске карты.
first_namestringдаИмя
idstringдаНаш идентификатор держателя. Справочный: храните свой external_id — дедупликация идёт только по нему, и повторная регистрация человека по этому id создаст ВТОРОГО держателя.
last_namestringдаФамилия

Примеры ответа

{
  "id": "b7e1c9d2-4a3f-4c8e-a6b5-1f2e3d4c5b6a",
  "external_id": "cust-42",
  "first_name": "Ivan",
  "last_name": "Petrov",
  "email": "ivan.petrov@example.com",
  "created_at": "2026-10-07T09:12:44Z"
}
{
  "title": "Not Found",
  "status": 404,
  "detail": "not_found",
  "errors": [
    {
      "message": "not_found",
      "location": "error.code",
      "value": "not_found"
    }
  ]
}

Ошибки

HTTPКодКогда
404not_foundДержатель с таким external_id не зарегистрирован.

Плюс общие ошибки подписи и лимитов — см. Ошибки.