All files / src/services p2p.types.ts

100% Statements 8/8
100% Branches 4/4
100% Functions 2/2
100% Lines 8/8

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  3x   3x   3x   3x   3x     3x 3x 3x                                                                                                                                                                                                                                                                                                              
/* eslint-disable unicorn/prevent-abbreviations */
export enum BillStatus {
  /** Счет выставлен, ожидает оплаты */
  WAITING = "WAITING",
  /** Счет оплачен */
  PAID = "PAID",
  /** Счет отклонен */
  REJECTED = "REJECTED",
  /** Время жизни счета истекло. Счет не оплачен */
  EXPIRED = "EXPIRED"
}
 
export enum BillCurrency {
  RUB = "RUB",
  KZT = "KZT"
}
 
export type BillCreationRequest = {
  /** Данные о сумме счета */
  amount: {
    /**
     * Сумма, на которую выставляется счет, округленная в меньшую
     * сторону до 2 десятичных знаков
     *
     * @type {number|string} Number(6.2)
     */
    value: number | string;
    /**
     * Валюта суммы счета. Возможные значения:
     * `RUB` - рубли
     * `KZT` - тенге
     */
    currency: BillCurrency;
  };
 
  /**
   * Дата, до которой счет будет доступен для оплаты. Если перевод
   * не будет совершен до этой даты, ему присваивается финальный
   * статус `EXPIRED` и последующий перевод станет невозможен.
   *
   * @type {string} URL-закодированная строка `ГГГГ-ММ-ДДTчч:мм:сс+\-чч:мм`
   *
   * @example
   * "2020-07-10T09:02:00+03:00"
   */
  expirationDateTime: string;
 
  /** Идентификаторы пользователя */
  customer?: {
    /** Номер телефона пользователя (в международном формате) */
    phone?: string;
 
    /** E-mail пользователя */
    email?: string;
 
    /** Идентификатор пользователя в вашей системе */
    account?: string;
  };
 
  /**
   * Комментарий к счету
   * @maxlength 255
   */
  comment?: string;
 
  /**
   * Дополнительные данные счета. Так же при помощи этого параметра вы
   * можете настроить
   * {@link https://developer.qiwi.com/ru/p2p-payments/#custom|персонализацию}
   * вашей формы, передав переменную `themeCode`
   */
  customFields?: Record<string, string>;
};
 
export type BillStatusData = {
  /** Уникальный идентификатор выставляемого счета в вашей системе */
  billId: string;
 
  /** Ваш идентификатор в системе p2p.qiwi */
  siteId: string;
 
  /** Данные о сумме счета */
  amount: BillCreationRequest["amount"];
 
  status: {
    /** Текущий статус счета */
    value: BillStatus;
    /** Дата обновления статуса */
    changedDateTime: string;
  };
 
  /** Объект строковых дополнительных параметров, переданных вами */
  customFields: Record<string, string>;
 
  /** Идентификаторы пользователя */
  customer?: BillCreationRequest["customer"];
 
  /** Комментарий к счету */
  comment?: string;
 
  /**
   * Системная дата создания счета. Формат даты:
   * `ГГГГ-ММ-ДДTчч:мм:сс`
   */
  creationDateTime: string;
 
  /**
   * {@link https://developer.qiwi.com/ru/p2p-payments/#option|Ссылка для переадресации}
   * пользователя на созданную форму
   */
  payUrl: string;
 
  /**
   * Срок действия созданной формы для перевода. Формат даты:
   * `ГГГГ-ММ-ДДTчч:мм:сс+\-чч:мм`
   */
  expirationDateTime: string;
};
 
export type BillError = {
  /** Название сервиса, зачастую начинается на `invoicing` */
  serviceName: string;
  /** Внутренний код ошибки */
  errorCode: string;
  /** Вот это надо пихать в поле `Error.message` */
  description: string;
  /**  */
  userMessage: string;
  /** Дата и время ответа */
  datetime: string;
  /** Хз что это */
  traceId: string;
};
 
export type BillFormParams = {
  /** Уникальный идентификатор выставляемого счета в вашей системе */
  billId: string;
  /** Ваш ключ идентификации полученный в p2p.qiwi.com */
  publicKey: string;
  /**
   * Сумма, на которую выставляется счет, округленная в меньшую
   * сторону до 2 десятичных знаков
   */
  amount: string | number;
  /**
   * URL для переадресации в случае успешного перевода с баланса
   * QIWI Кошелька. При ином способе оплаты переадресация не
   * выполняется. Ссылка должна вести на ваш сайт.
   */
  successUrl?: string;
  /** Комментарий к счету */
  comment?: string;
  /** Дополнительные данные счета */
  customFields?: Record<string, string>;
  /**
   * Дата, до которой счет будет доступен для перевода. Если
   * перевод по счету не будет произведен до этой даты, ему
   * присваивается финальный статус EXPIRED и последующий перевод
   * станет невозможен.
   *
   * **Внимание! По истечении 45 суток от даты выставления счет
   * автоматически будет переведен в финальный статус**
   */
  lifetime?: string;
} & BillCreationRequest["customer"];