All files / src/services personal.types.ts

100% Statements 66/66
100% Branches 18/18
100% Functions 9/9
100% Lines 66/66

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171    3x   3x   3x       3x         3x     3x   3x   3x   3x   3x       3x   3x   3x   3x     3x   3x   3x   3x   3x                     3x 3x 3x     3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x   3x               3x     3x     3x               3x               3x     3x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               3x   3x     3x     3x     3x     3x     3x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     3x   3x     3x     3x     3x     3x                                                                                                                                                                                                                                                                     3x 3x 3x 3x 3x                                                                                                                                                                                                                                                                                                                                      
/* eslint-disable camelcase */
/* eslint-disable unicorn/prevent-abbreviations */
export enum PersonIdentificationLevel {
  /** Пользователь не вошёл в кошелёк */
  ANONYMOUS = "ANONYMOUS",
  /** "Минимальный" */
  SIMPLE = "SIMPLE",
  /**
   * "Основной" (данные для идентификации успешно прошли проверку)
   */
  VERIFIED = "VERIFIED",
  /**
   * "Профессиональный", если кошелек уже ранее получал полную
   * идентификацию по данным ФИО, номеру паспорта и дате рождения.
   */
  FULL = "FULL"
}
 
export enum TransactionType {
  /** Все операции */
  ALL = "ALL",
  /** Только пополнения */
  IN = "IN",
  /** Только платежи */
  OUT = "OUT",
  /** Платежи по картам QIWI (QVC, QVP) */
  QIWI_CARD = "QIWI_CARD"
}
 
/** Статус платежа */
export enum TransactionStatus {
  /** Платеж проводится */
  WAITING = "WAITING",
  /** Успешный платеж */
  SUCCESS = "SUCCESS",
  /** Ошибка платежа */
  ERROR = "ERROR"
}
 
export enum Currency {
  /** Рубли */
  RUB = 643,
  /** Доллары */
  USD = 840,
  /** Евро */
  EUR = 978,
  /** Тенге */
  KZT = 398
}
 
export type MoneyAmount = {
  /** Сумма */
  amount: number;
 
  /** Валюты */
  currency: Currency;
};
 
export enum ChequeFormat {
  JPEG = "JPEG",
  PDF = "PDF"
}
 
export enum Recipients {
  /** Альфа Банк */
  AlfaBank = 464,
  /** Тинькофф Банк */
  TinkoffBank = 466,
  /** ОТП Банк */
  OTPBank = 804,
  /** РосСельхозБанк */
  RosSelkhozBank = 810,
  /** Банк "Русский Стандарт" */
  RusskiyStandardBank = 815,
  /** ВТБ */
  VTBank = 816,
  /** ПромСвязьБанк */
  PromSvyazBank = 821,
  /** Сбербанк */
  SberBank = 870,
  /** Ренессанс Кредит */
  RenessansCreditBank = 881,
  /** Московский Кредитный Банк */
  MKBank = 1134,
  /** Перевод на карту VISA по России */
  VisaRusCard = 1963,
  /** Перевод на карту VISA по СНГ */
  VisaSngCard = 1960,
  /** Перевод на карту MasterCard по России */
  MasterCardRus = 21_013,
  /** Перевод на карту MasterCard по СНГ */
  MasterCardSng = 21_012,
  /** Перевод на карту МИР */
  MirCard = 31_652,
  /** Перевод в `OnLime` */
  OnLime = 674,
  /** Перевод в фонд "Подари Жизнь" */
  PodariZhiznFound = 1239,
  /** Перевод на QIWI-Кошелёк по номеру телефона */
  QIWI = 99,
  /** Перевод на QIWI-Кошелёк по никнейму */
  QIWINickname = 99_999,
 
  /**
   * Перевод на QIWI-Кошелёк по никнейму
   * @deprecated Переименовано в `QIWINickname`
   * @see {@link QIWINickname}
   */
  // eslint-disable-next-line camelcase
  QIWI_Nickname = 99_999,
 
  /** Перевод по банковским реквизитам */
  BankRequisites = 1717,
 
  /** Перевод на QIWI-Кошелёк по номеру виртуальной карты */
  QIWIVirtualCard = 22_351,
 
  /**
   * Перевод на QIWI-Кошелёк по номеру виртуальной карты
   * @deprecated Переименовано в `QIWIVirtualCard`
   * @see {@link QIWIVirtualCard}
   */
  // eslint-disable-next-line camelcase
  QIWI_VirtualCard = 22_351,
 
  /**
   * Перевод в Яндекс.Деньги
   *
   * @deprecated Сейчас называется `YooMoney`
   * @see {@link YooMoney}
   */
  YandexMoney = 26_476,
 
  /** Перевод в YooMoney (бывшие Яндекс.Деньги) */
  YooMoney = 26_476
}
 
export type PersonProfile = {
  /**
   * Текущие настройки авторизации. Объект может отсутствовать, в
   * зависимости от признака `authInfoEnabled` в запросе.
   */
  authInfo: {
    /** Номер кошелька */
    personId: number;
    /**
     * Дата/время регистрации QIWI Кошелька
     * (через сайт/мобильное приложение, либо другим способом)
     */
    registrationDate: string;
    /**
     * E-mail, привязанный к кошельку. Если отсутствует, то `null`
     */
    boundEmail: string | null;
    /** IP-адрес последней пользовательской сессии */
    ip: string;
    /** Дата/время последней сессии в QIWI Кошельке */
    lastLoginDate: string;
    /** Данные о PIN-коде мобильного приложения QIWI Кошелька */
    mobilePinInfo: {
      /**
       * Логический признак использования PIN-кода
       * (фактически означает, что мобильное приложение
       * используется)
       */
      mobilePinUsed: boolean;
 
      /**
       * Дата/время последнего изменения PIN-кода мобильного
       * приложения QIWI Кошелька
       */
      lastMobilePinChange: string;
 
      /**
       * Дата/время следующего (планового) изменения PIN-кода
       * мобильного приложения QIWI Кошелька
       */
      nextMobilePinChange: string;
    };
 
    /** Данные об использовании пароля к сайту qiwi.com */
    passInfo: {
      /**
       * Логический признак использования пароля
       * (фактически означает использование сайта qiwi.com)
       */
      passwordUsed: boolean;
 
      /** Дата/время последнего изменения пароля сайта qiwi.com */
      lastPassChange: string;
 
      /**
       * Дата/время следующего (планового) изменения пароля
       * сайта qiwi.com
       * */
      nextPassChange: string;
    };
 
    /**
     * Данные об использовании PIN-кода к приложению
     * QIWI Кошелька на QIWI терминалах самообслуживания
     */
    pinInfo: {
      /**
       * Логический признак использования PIN-кода для терминала
       * (фактически означает факт использования приложения
       * QIWI Кошелька на терминале)
       */
      pinUsed: boolean;
    };
  };
 
  /**
   * Информация о кошельке. Объект может отсутствовать, в
   * зависимости от признака `contractInfoEnabled` в запросе.
   */
  contractInfo: {
    /** Логический признак блокировки кошелька */
    blocked: boolean;
 
    /** Номер кошелька */
    contractId: number;
 
    /**
     * Дата/время создания QIWI Кошелька (через сайт/мобильное
     * приложение, либо при первом пополнении, либо другим
     * способом)
     */
    creationDate: string;
 
    /** Служебная информация */
    features: object[];
 
    /**
     * Данные об
     * {@link https://qiwi.com/settings/identification#ru|идентификации}
     * пользователя.
     */
    identificationInfo: {
      bankAlias: "QIWI" | string;
      /**
       * Текущий уровень идентификации кошелька.
       * Возможные значения:
       *
       * `ANONYMOUS` - без идентификации;
       *
       * `SIMPLE`, `VERIFIED` - упрощенная идентификация;
       *
       * `FULL` - полная идентификация.
       */
      identificationLevel: PersonIdentificationLevel;
    }[];
  };
 
  /**
   * Прочие пользовательские данные. Объект может отсутствовать,
   * в зависимости от признака `userInfoEnabled` в запросе.
   */
  userInfo: {
    /**
     * Код валюты баланса кошелька по умолчанию (number-3 ISO-4217)
     */
    defaultPayCurrency: Currency;
 
    /** Служебная информация */
    defaultPaySource: number;
 
    /** E-mail пользователя */
    email: string;
 
    /** Номер первой транзакции после регистрации */
    firstTxnId: string;
 
    /** Служебная информация */
    language: string;
 
    /** Название мобильного оператора номера пользователя */
    operator: string;
 
    /** Служебная информация */
    phoneHash: string;
 
    /** Служебная информация */
    promoEnabled: string;
  };
};
 
export type IdentificationBase = {
  /** Дата рождения пользователя (в формате "ГГГГ-ММ-ДД") */
  birthDate: string;
 
  /** Имя пользователя */
  firstName: string;
 
  /** Отчество пользователя */
  middleName: string;
 
  /** Фамилия пользователя */
  lastName: string;
 
  /** Серия и номер паспорта пользователя (только цифры) */
  passport: string;
 
  /** ИНН пользователя */
  inn: string;
 
  /** Номер СНИЛС пользователя */
  snils: string;
 
  /** Номер полиса ОМС пользователя */
  oms: string;
};
 
export type IdentificationResponse = IdentificationBase & {
  /** Номер кошелька пользователя */
  id: number;
 
  /**
   * Текущий статус кошелька:
   *
   * `SIMPLE` - "Минимальный".
   *
   * `VERIFIED` - "Основной" (данные для идентификации успешно
   * прошли проверку).
   *
   * `FULL` – "Профессиональный", если кошелек уже ранее получал
   * полную идентификацию по данным ФИО, номеру паспорта и дате
   * рождения.
   */
  type:
    | PersonIdentificationLevel.SIMPLE
    | PersonIdentificationLevel.VERIFIED
    | PersonIdentificationLevel.FULL;
};
 
export type Restrictions = {
  /** Код блокировки */
  restrictionCode: string;
 
  /** Описание блокировки */
  restrictionDescription: string;
}[];
 
export type GetPaymentHistoryParamsBase = {
  /**
   * Число платежей в ответе, для разбивки отчета на страницы.
   * Целое число от 1 до 50. Запрос возвращает указанное число
   * платежей в обратном хронологическом порядке, начиная от
   * текущей даты или даты в параметре `startDate`
   */
  rows: number;
 
  /**
   * Тип операций в отчете, для отбора. Допустимые значения:
   *
   * `ALL` - все операции,
   *
   * `IN` - только пополнения,
   *
   * `OUT` - только платежи,
   *
   * `QIWI_CARD` - только платежи по картам QIWI (QVC, QVP).
   *
   * По умолчанию `ALL`
   */
  operation?: TransactionType;
 
  /**
   * Список источников платежа, для фильтра. Каждый источник
   * нумеруется, начиная с нуля (`sources[0]`, `sources[1]` и т.д.).
   *
   * Допустимые значения:
   *
   * `QW_RUB` - рублевый счет кошелька,
   *
   * `QW_USD` - счет кошелька в долларах,
   *
   * `QW_EUR` - счет кошелька в евро,
   *
   * `CARD` - привязанные и непривязанные к кошельку банковские
   * карты,
   *
   * `MK` - счет мобильного оператора. Если не указан, учитываются
   * все источники
   */
  sources?: ("QW_RUB" | "QW_USD" | "QW_EUR" | "CARD" | "MK")[];
};
 
export type GetPaymentHistoryParamsStartEnd = {
  /**
   * Начальная дата поиска платежей. **Используется только вместе
   * с `endDate`. Максимальный допустимый интервал между
   * `startDate` и `endDate` - 90 календарных дней.** По умолчанию,
   * равна суточному сдвигу от текущей даты по московскому времени.
   *
   * Дату можно указать в любой временной зоне `TZD`
   * (формат `ГГГГ-ММ-ДД'T'чч:мм:ссTZD`), однако она должна
   * совпадать с временной зоной в параметре `endDate`. Обозначение
   * временной зоны `TZD`: +`чч:мм` или -`чч:мм`
   * (временной сдвиг от GMT).
   */
  startDate: string;
 
  /**
   * Начальная дата поиска платежей. **Используется только вместе
   * с `startDate`. Максимальный допустимый интервал между
   * `startDate` и `endDate` - 90 календарных дней.** По умолчанию,
   * равна суточному сдвигу от текущей даты по московскому времени.
   *
   * Дату можно указать в любой временной зоне `TZD`
   * (формат `ГГГГ-ММ-ДД'T'чч:мм:ссTZD`), однако она должна
   * совпадать с временной зоной в параметре `startDate`.
   * Обозначение временной зоны `TZD`: +`чч:мм` или -`чч:мм`
   * (временной сдвиг от GMT).
   */
  endDate: string;
};
 
export type GetPaymentHistoryParams =
  | GetPaymentHistoryParamsBase
  | (GetPaymentHistoryParamsBase & GetPaymentHistoryParamsStartEnd)
  | (GetPaymentHistoryParamsBase & {
      /**
       * Дата транзакции для начала отчета (должна быть равна
       * параметру `nextTxnDate` в предыдущем списке). Используется
       * для продолжения списка, разбитого на страницы.
       * **Используется только вместе с `nextTxnId`**
       */
      nextTxnDate: string;
 
      /**
       * Номер транзакции для начала отчета (должен быть равен
       * параметру `nextTxnId` в предыдущем списке). Используется
       * для продолжения списка, разбитого на страницы.
       * **Используется только вместе с `nextTxnDate`**
       */
      nextTxnId: number;
    });
 
export type GetPaymentHistoryTotalParams = Omit<
  GetPaymentHistoryParamsBase,
  "rows"
> &
  GetPaymentHistoryParamsStartEnd;
 
export type GetPaymentHistoryTotalResponse = {
  /**
   * Данные о входящих платежах (пополнениях), отдельно по каждой
   * валюте
   */
  incomingTotal: MoneyAmount[];
 
  /** Данные об исходящих платежах, отдельно по каждой валюте */
  outgoingTotal: MoneyAmount[];
};
 
export type Transaction = {
  /** ID транзакции в сервисе QIWI Кошелек */
  txnId: number;
 
  /** Номер кошелька */
  personId: number;
 
  /**
   * Для запросов истории платежей - Дата/время платежа, во
   * временной зоне запроса (см. параметр `startDate`). Формат
   * даты `ГГГГ-ММ-ДД'T'чч:мм:сс+03:00`
   *
   * Для запросов данных о транзакции - Дата/время платежа, время
   * московское (в формате `ГГГГ-ММ-ДД'T'чч:мм:сс+03:00`)
   */
  date: string;
 
  /** {@link https://developer.qiwi.com/ru/qiwi-wallet-personal/#errorCode|Код ошибки платежа} */
  errorCode: number;
 
  /** Описание ошибки */
  error: string | null;
 
  /**
   * Тип платежа. Возможные значения:
   *
   * `IN` - пополнение,
   *
   * `OUT` - платеж,
   *
   * `QIWI_CARD` - платеж с карт QIWI (QVC, QVP).
   */
  type: TransactionType.IN | TransactionType.OUT | TransactionType.QIWI_CARD;
 
  /**
   * Статус платежа. Возможные значения:
   *
   * `WAITING` - платеж проводится
   *
   * `SUCCESS` - успешный платеж
   *
   * `ERROR` - ошибка платежа.
   */
  status: TransactionStatus;
 
  /** Текстовое описание статуса платежа */
  statusText: string;
 
  /** Клиентский ID транзакции */
  trmTxnId: string;
 
  /**
   * Для платежей - номер счета получателя. Для пополнений - номер
   * отправителя, терминала или название агента пополнения кошелька
   */
  account: string;
 
  /** Данные о сумме платежа или пополнения. */
  sum: MoneyAmount;
 
  /**	Данные о комиссии платежа */
  commission: MoneyAmount;
 
  /** Данные о фактической сумме платежа или пополнения. */
  total: MoneyAmount;
 
  /** Данные о провайдере. */
  provider: {
    /** ID провайдера в QIWI Wallet */
    id: number;
 
    /** краткое наименование провайдера */
    shortName: string;
 
    /** развернутое наименование провайдера */
    longName: string;
 
    /** ссылка на логотип провайдера */
    logoUrl: string | null;
 
    /** описание провайдера (HTML) */
    descriptions: string | null;
 
    /** список ключевых слов */
    keys: string | null;
 
    /** сайт провайдера */
    siteUrl: string | null;
  };
 
  /** Служебная информация */
  source: object;
 
  /** Комментарий к платежу */
  comment: string;
 
  /** Курс конвертации (если применяется в транзакции) */
  currencyRate: number;
 
  /** Служебная информация */
  extras: object;
 
  /**
   * Поидее содержимое этого поля должно быть напрямую в
   * Transaction. Но QIWI возвращает именно так
   */
  features: {
    /** Специальное поле */
    chequeReady: boolean;
 
    /** Специальное поле */
    bankDocumentAvailable: boolean;
 
    /** Специальное поле */
    repeatPaymentEnabled: boolean;
 
    /** Специальное поле */
    favoritePaymentEnabled: boolean;
 
    /** Специальное поле */
    regularPaymentEnabled: boolean;
  };
};
 
export type GetTransactionsHistoryResponse = {
  /**
   * Список объектов {@link https://developer.qiwi.com/ru/qiwi-wallet-personal/#txnid|Transaction}.
   * Число транзакций в списке меньше или равно параметру rows из
   * запроса
   */
  data: Transaction[];
 
  /** ID следующей транзакции в полном списке */
  nextTxnId: Transaction["txnId"] | null;
 
  /**
   * Дата/время следующей транзакции в полном списке, время
   * московское (в формате `ГГГГ-ММ-ДД'T'чч:мм:сс+03:00`)
   */
  nextTxnDate: Transaction["date"] | null;
};
 
export enum LimitType {
  /** Максимальный допустимый остаток на счёте */
  REFILL = "REFILL",
 
  /** Оборот в месяц */
  TURNOVER = "TURNOVER",
 
  /** Переводы на другие кошельки в месяц */
  PAYMENTS_P2P = "PAYMENTS_P2P",
 
  /** Платежи в адрес иностранных компаний в месяц */
  PAYMENTS_PROVIDER_INTERNATIONALS = "PAYMENTS_PROVIDER_INTERNATIONALS",
 
  /** Переводы на банковские счета и карты, кошельки других систем */
  PAYMENTS_PROVIDER_PAYOUT = "PAYMENTS_PROVIDER_PAYOUT",
 
  /** Снятие наличных в месяц */
  WITHDRAW_CASH = "WITHDRAW_CASH"
}
 
export type Limit<
  Cur extends keyof typeof Currency = "RUB",
  Type extends LimitType = LimitType
> = {
  /** Валюта операций */
  currency: Cur;
 
  /**
   * Остаток лимита, который можно потратить в данный период
   * (период задается в параметре `interval`)
   */
  rest: number;
 
  /** Значение лимита */
  max: number;
 
  /** Сумма, потраченная по данным операциям */
  spent: number;
 
  /** Сведения о периоде действия лимита */
  interval: {
    /** Начало периода, формат даты `ГГГГ-ММ-ДДТЧЧ:ММ:ССtmz` */
    dateFrom: string;
 
    /** Конец периода, формат даты `ГГГГ-ММ-ДДТЧЧ:ММ:ССtmz` */
    dateTill: string;
  };
 
  /** Тип операций, на которые действует данный лимит */
  type: Type;
};
 
export type LimitsResponse<RequestedLimits extends LimitType = LimitType> = {
  /** Описание лимитов */
  limits: {
    /** Массив лимитов на операции */
    RU: Limit<"RUB", RequestedLimits>[];
    KZ: Limit<"KZT", RequestedLimits>[];
  };
};
 
export type Account = {
  /** Псевдоним пользовательского баланса */
  alias: string;
 
  /** Псевдоним банковского баланса */
  fsAlias: string;
 
  /** Псевдоним банка */
  bankAlias: string;
 
  /** Название соответствующего счета кошелька */
  title: string;
 
  /** Сведения о счете */
  type: {
    /** Описание счета */
    id: string;
 
    /** Описание счета */
    title: string;
  };
 
  /**
   * Логический признак реального баланса в системе QIWI Кошелек
   * (не привязанная карта, не счет мобильного телефона и т.д.)
   */
  hasBalance: boolean;
 
  balance: MoneyAmount | null;
 
  /** Код валюты баланса (number-3 ISO-4217) */
  currency: Currency;
 
  defaultAccount?: boolean;
};
 
export type GetAccountsResponse = {
  /** Массив балансов */
  accounts: Account[];
};
 
export type AccountOffer = {
  /** Псевдоним счета */
  alias: string;
 
  /** ID валюты счета */
  currency: Currency;
};
 
export type GetAccountOffersResponse = AccountOffer[];
 
export type PaymentCommissionRequest = {
  /**
   * Пользовательский идентификатор (номер телефона с международным
   * префиксом, номер карты/счета получателя, и т.д., в зависимости
   * от провайдера)
   */
  account: string;
 
  /** Объект, определяющий обработку платежа процессингом QIWI Wallet */
  paymentMethod: {
    /** Метод платежа, только `Account` */
    type: "Account";
 
    /** Идентификатор счета, только `643`. */
    accountId: "643";
  };
 
  /** Объект с платежными реквизитами */
  purchaseTotals: {
    /** Объект, содержащий данные о сумме платежа */
    total: {
      /**
       * Сумма (можно указать рубли и копейки, разделитель .).
       * Положительное число, округленное до 2 знаков после
       * десятичной точки. При большем числе знаков значение будет
       * округлено до копеек в меньшую сторону.
       */
      amount: number;
 
      /** Валюта (только 643, рубли) */
      currency: "643";
    };
  };
};
 
export type PaymentResponse = {
  /** Копия параметра `id` из платежного запроса */
  id: string;
 
  /** Идентификатор провайдера, на которого был отправлен платеж */
  terms: string;
 
  /**
   * Копия объекта `fields` из платежного запроса. **Номер
   * карты (если был выполнен перевод на карту) возвращается в
   * маскированном виде**
   */
  fields: Record<string, string>;
 
  /** Копия объекта `sum` из платежного запроса */
  sum: MoneyAmount;
 
  transaction: {
    id: string;
    state: {
      code: "Accepted";
    };
  };
 
  /** Константа, `account_643` */
  source: "account_643";
 
  /**
   * Копия параметра `comment` из платежного запроса (возвращается,
   * если присутствует в запросе)
   */
  comment?: string;
};
 
export type FormUrlOptions = {
  /** Сумма платежа в рублях */
  amount?: number;
 
  /** Комментарий. **Параметр используется только для `ID=99`** */
  comment?: string;
 
  /**
   * Формат совпадает с форматом параметра `fields.account` при
   * оплате соответствующих провайдеров: для провайдера `99` -
   * номер кошелька получателя; для провайдеров сотовой связи -
   * номер мобильного телефона для пополнения (без префикса 8);
   * для провайдеров перевода на карту - номер банковской карты
   * получателя (без пробелов), для других провайдеров -
   * идентификатор пользователя. Для провайдера `99999` указывается
   * никнейм или номер кошелька получателя (задайте
   * соответствующее значение параметра `extra['accountType']`).
   */
  account?: string;
 
  /**
   * Признак неактивного поля формы. Пользователь не сможет менять
   * значение данного поля. Каждый параметр задает соответствующее
   * поле формы и нумеруется начиная с нуля (blocked[0], blocked[1]
   *  и т.д.). Если не указан, пользователь сможет изменить все
   * поля формы.
   *
   * Допустимые значения:
   *
   * `sum` - поле "сумма платежа",
   *
   * `account` - поле "номер счета/телефона/карты",
   *
   * `comment` - поле "комментарий".
   *
   * Пример (неактивное поле суммы платежа): `blocked[0]=sum`
   */
  blocked?: ("account" | "comment" | "sum")[];
 
  /**
   * **Параметр используется только для ID=99999**. Значение
   * определяет перевод на QIWI кошелек по никнейму или по номеру
   * кошелька. Если вы не хотите, чтобы пользователь видел номер
   * вашего кошелька на форме, используйте перевод по никнейму.
   *
   * `phone` - для перевода по номеру
   *
   * `nickname` - для перевода по никнейму.
   */
  accountType?: string;
 
  custom?: Record<string, unknown>;
};
 
export type CodeResponse = {
  code: string;
};
 
export type TokenResponse = {
  /** Токен с расширенным сроком действия */
  access_token: string;
 
  /** Тип токена */
  token_type: "Bearer";
 
  /** Кол-во секунд в формате строки: `"316224000"` */
  expires_in: string;
 
  /** Не используется */
  refresh_token: string;
};
 
export type PrettyTokenResponse<C> = {
  token: string;
  expiry: number;
  client: C;
};
 
/** Статус карты */
export enum CardStatus {
  /** Активна */
  ACTIVE = "ACTIVE",
 
  /** Отправлена в банк */
  SENDED_TO_BANK = "SENDED_TO_BANK",
 
  /** Отправлена владельцу */
  SENDED_TO_USER = "SENDED_TO_USER",
 
  /** Заблокированная */
  BLOCKED = "BLOCKED",
 
  /** Хз */
  UNKNOWN = "UNKNOWN"
}
 
type ImageObject = {
  /** URL изображения */
  url: string;
 
  /** Ширина изображения */
  width: number;
 
  /** Высота изображения */
  height: number;
 
  /**
   * Размер изображения относительно минимального в наборе.
   * Пример: `2x`
   */
  ratio: string;
};
 
type KVObject = { name: string; value: string };
 
export type CardResponse = {
  /** Общая информация о карте */
  qvx: {
    /** ID карты */
    id: number;
 
    /**
     * Маскированный номер карты (отображаются только последние 4
     * цифры). Пример: `****9078`
     */
    maskedPan: string;
 
    /** Текущий статус карты */
    status: CardStatus;
 
    /** Срок действия карты в формате: `2022-01-31T00:00:00+03:00` */
    cardExpire: string;
 
    /** Вид карты */
    cardType: "VIRTUAL" | "PLASTIC";
 
    /** [Название карты](https://developer.qiwi.com/ru/qiwi-wallet-personal/?http#qvc-rename) в интерфейсе сайта [qiwi.com](https://qiwi.com/) */
    cardAlias: string;
 
    cardLimit: null | {
      value: number;
      currencyCode: Currency;
    };
 
    /** Дата активации карты в формате: `2022-01-31T00:00:00+03:00` */
    activated: string;
 
    /** Дата высылки СМС с реквизитами в формате: `2022-01-31T00:00:00+03:00` */
    smsResended: string;
 
    /** Дата блокировки в формате: `2022-01-31T00:00:00+03:00` */
    blockedDate: string;
 
    /** Признак возможности разблокировать карту */
    unblockAvailable: boolean;
 
    /** ID транзакции заказа карты */
    txnId: string;
 
    /** Месяц окончания действия карты. Например: `01` */
    cardExpireMonth: string;
 
    /** Год окончания действия карты. Например: `2022` */
    cardExpireYear: string;
  };
 
  /** Данные баланса карты */
  balance: MoneyAmount | null;
 
  /** Тарифы и банковские реквизиты карты */
  info: {
    /** [Тип карты](https://developer.qiwi.com/ru/qiwi-wallet-personal/?http#card-types) */
    alias: "qvc-cpa" | "qvc-cpa-debit" | "qvp-gold";
 
    /** Название карты */
    name: string;
 
    /**
     * Тариф карты:
     *
     * `amount` - Стоимость обслуживания
     * `currency` - Код валюты баланса (по ISO)
     */
    price: MoneyAmount;
 
    /** Период обслуживания (по тарифу). Пример: `за год` */
    period: string;
 
    details: {
      /** Краткое описание тарифа карты. Пример: `99 ₽, действует 1 год` */
      info: string;
 
      /** Описание карты */
      description: string;
 
      /** Изображения карты для лендинга с "примерными" данными */
      images: ImageObject[];
 
      /** Иконки карты */
      imagesMin: ImageObject[];
 
      /** Изображения карты без данных */
      imagesDet: ImageObject[];
 
      /** Список условий обслуживания карты */
      tariffs: KVObject[];
 
      /** Ссылка на описание тарифа */
      tariffLink: string;
 
      /** Ссылка на договор оферты на выпуск карты */
      offerLink: string;
 
      /** Список возможностей карты на русском */
      features: string[];
 
      /** Список пар "ключ-значение" с данными банковских реквизитов для пополнения карты */
      requisites: KVObject[];
    };
 
    [key: string]: any;
  };
};
 
export enum CardActionStatus {
  OK = "OK",
  FAIL = "FAIL",
  CONFIRMATION_REQUIRED = "CONFIRMATION_REQUIRED",
  CONFIRMATION_LIMIT_EXCEED = "CONFIRMATION_LIMIT_EXCEED"
}
 
export type CardUnblockResponse = {
  status: CardActionStatus;
  nextConfirmationRequest: null;
  confirmationId: null;
  operationId: null;
};
 
export type CardRequisitesResponse = {
  status: CardActionStatus;
 
  /** CVV карты */
  cvv: string;
 
  /** Полный номер карты */
  pan: string;
 
  /** Код ошибки */
  errorCode: string;
 
  [key: string]: any;
};
 
export type CardRenameResponse = {
  status: CardActionStatus.OK | CardActionStatus.FAIL;
 
  /** Текстовое описание ошибки */
  error: string;
 
  /** Код ошибки */
  errorCode: string;
};
 
export type FreePayFields = {
  /**
   * Наименование банка получателя. Например: `ПАО "Сбербанк"`
   */
  name: string;
 
  /**
   * БИК банка получателя
   */
  to_bik: string;
 
  /**
   * БИК банка получателя. Почти всегда равен `to_bik`
   */
  extra_to_bik: string;
 
  /**
   * Город местонахождения получателя
   */
  city: string;
 
  info: "Коммерческие организации";
  is_commercial: "1";
 
  /**
   * Наименование организации. Например: `ООО "Технический Центр ДЕЛЬТА"`
   */
  to_name: string;
 
  /**
   * ИНН организации
   */
  to_inn: string;
 
  /**
   * КПП организации
   */
  to_kpp: string;
 
  /**
   * Признак уплаты НДС. Если вы оплачиваете квитанцию и в ней не
   * указан НДС, то строка `НДС не облагается`. В ином случае,
   * строка `В т.ч. НДС`.
   */
  nds: "НДС не облагается" | "В т.ч. НДС";
 
  /**
   * Назначение платежа
   */
  goal: string;
 
  /**
   * Признак срочного платежа (`0` - нет, `1` - да). Срочный
   * платеж выполняется от 10 минут. Возможен по будням с 9:00
   * до 20:30 по московскому времени.
   *
   * **Стоимость услуги — 25 рублей.**
   */
  urgent: "0" | "1";
 
  /**
   * Имя плательщика
   */
  from_name: string;
 
  /**
   * Отчество плательщика
   */
  from_name_p: string;
 
  /**
   * Фамилия плательщика
   */
  from_name_f: string;
 
  requestProtocol: "qw1";
  toServiceId: "1717";
 
  /**
   * Номер счета получателя
   */
  account: string;
};
 
/**
 * @see [Документация по платежам](https://developer.qiwi.com/ru/qiwi-wallet-personal/#payments)
 */
export type Pay2Params = {
  /**
   * Ака ID в доках, номер провайдера(платёжной системы) у QIWI
   *
   * @see {@link Recipients}
   * @default 99
   */
  provider?: number | Recipients;
 
  /**
   * Номер счёта в указанной платёжной системе (у `provider`'а)
   * Если он не задан, но следует указывать номер телефона(киви)
   * получателя.
   *
   * Записывается в `fields.account`, можно поставить `""`, если
   * переопределяете в `fields`
   */
  account: string;
 
  /**
   * Сумма платежа в указанной валюте. Если валюта не указана, то
   * в рублях. Советую округлять до 2ух знаков после ,
   */
  amount: number;
 
  /**
   * Валюта платежа
   */
  currency?: Currency;
 
  /**
   * Дополнительные параметры платежа. Обычно необходимо для
   * [платежа по свободным реквизитам](https://developer.qiwi.com/ru/qiwi-wallet-personal/#freepay)
   */
  fields?: Partial<FreePayFields> & Record<string, string>;
 
  /**
   * Комментарий к платежу
   */
  comment?: string;
};