@vality/swag-payments 0.1.3-e658db3.0 → 0.1.3-fd6802c.0

package/model/paymentInteractionRequested.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { InvoiceChange } from './invoiceChange';
+import { UserInteraction } from './userInteraction';
+export interface PaymentInteractionRequested extends InvoiceChange {
+    /**
+     * Payment ID
+     */
+    paymentID: string;
+    userInteraction: UserInteraction;
+}
+export declare namespace PaymentInteractionRequested {
+}

package/model/paymentMethod.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentMethod {
+    /**
+     * Payment method
+     */
+    method: PaymentMethod.MethodEnum;
+}
+export declare namespace PaymentMethod {
+    type MethodEnum = 'BankCard' | 'PaymentTerminal' | 'DigitalWallet' | 'CryptoWallet' | 'MobileCommerce';
+    const MethodEnum: {
+        BankCard: MethodEnum;
+        PaymentTerminal: MethodEnum;
+        DigitalWallet: MethodEnum;
+        CryptoWallet: MethodEnum;
+        MobileCommerce: MethodEnum;
+    };
+}

package/model/paymentParams.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payer } from './payer';
+import { PaymentFlow } from './paymentFlow';
+export interface PaymentParams {
+    /**
+     * A platform-unique entity identifier for this party. It is used to ensure request idempotency.
+     */
+    externalID?: string;
+    flow: PaymentFlow;
+    payer: Payer;
+    /**
+     * Maximum payment processing time
+     */
+    processingDeadline?: string;
+    /**
+     * An indication of the creation of a parent recurrence payment. Successful payment with this attribute can be used as a parent payment in other recurring payments.
+     */
+    makeRecurrent?: boolean;
+    /**
+     * Metadata to be linked with the payment
+     */
+    metadata?: object;
+}

package/model/paymentRecurrentParent.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Parent payment, on the basis of which the current recurrent payment was created
+ */
+export interface PaymentRecurrentParent {
+    /**
+     * Invoice identifier
+     */
+    invoiceID: string;
+    /**
+     * Payment identifier
+     */
+    paymentID: string;
+}

package/model/paymentResource.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+import { PaymentResourceClientInfo } from './paymentResourceClientInfo';
+/**
+ * Disposable payment tool data
+ */
+export interface PaymentResource {
+    /**
+     * A payment tool token provided by the payer. _Required when creating a payment or binding, can be obtained during [tokenization](#operation/createPaymentResource)_.
+     */
+    paymentToolToken?: string;
+    /**
+     * Payment session identifier. _Required when creating a payment or binding, can be obtained during [tokenization](#operation/createPaymentResource)_.
+     */
+    paymentSession?: string;
+    paymentToolDetails?: PaymentToolDetails;
+    clientInfo?: PaymentResourceClientInfo;
+}

package/model/paymentResourceClientInfo.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentResourceClientInfo {
+    /**
+     * Payer\'s user agent unique fingerprint
+     */
+    fingerprint: string;
+    /**
+     * Payer IP-address
+     */
+    ip?: string;
+    /**
+     * URL from which the payment form was received by the client
+     */
+    url?: string;
+}

package/model/paymentResourceParams.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentTool } from './paymentTool';
+import { ClientInfo } from './clientInfo';
+export interface PaymentResourceParams {
+    paymentTool: PaymentTool;
+    clientInfo: ClientInfo;
+}

package/model/paymentResourcePayer.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payer } from './payer';
+import { PaymentToolDetails } from './paymentToolDetails';
+import { ContactInfo } from './contactInfo';
+import { PaymentResourceClientInfo } from './paymentResourceClientInfo';
+/**
+ * Disposable payment tool
+ */
+export interface PaymentResourcePayer extends Payer {
+    /**
+     * A payment tool token provided by the payer. _Required when creating a payment or binding, can be obtained during [tokenization](#operation/createPaymentResource)_.
+     */
+    paymentToolToken?: string;
+    /**
+     * Payment session identifier. _Required when creating a payment or binding, can be obtained during [tokenization](#operation/createPaymentResource)_.
+     */
+    paymentSession?: string;
+    paymentToolDetails?: PaymentToolDetails;
+    clientInfo?: PaymentResourceClientInfo;
+    contactInfo: ContactInfo;
+}

package/model/paymentResourceResult.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+import { PaymentResourceClientInfo } from './paymentResourceClientInfo';
+/**
+ * Disposable payment tool data
+ */
+export interface PaymentResourceResult {
+    /**
+     * Payment tool token provided by the payer
+     */
+    paymentToolToken: string;
+    /**
+     * Clean resource token. Can be used for differentiating one resource from another.
+     */
+    resourceToken?: string;
+    /**
+     * Payment session identifier
+     */
+    paymentSession: string;
+    paymentToolDetails?: PaymentToolDetails;
+    clientInfo?: PaymentResourceClientInfo;
+    /**
+     * Date and time until which the payment resource token remains valid
+     */
+    readonly validUntil?: string;
+}

package/{lib/model → model}/paymentSearchResult.d.ts

@@ -1,8 +1,6 @@
 /**
  * Vality Payments API
- * ## Description API is designed for the merchants who accept payments via user interface such as a website or a mobile app and it is the only interaction point with the system for goods and services payment transactions. ## Interaction details Whenever an API is accessed, its unique ID must be passed in the header X-Request-ID of the corresponding request: ```  X-Request-ID: 37d735d4-0f42-4f05-89fa-eaa478fb5aa9 ``` ### Content type and coding The system accepts and returns data in JSON format and UTF-8 coding: ```   Content-Type: application/json; charset=utf-8 ``` ### Date formats The system accepts and returns timestamp values in the format date-time, described in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339): ```   2017-01-01T00:00:00Z   2017-01-01T00:00:01+00:00 ``` ### Maximum request processing time Whenever an API is accessed, the time cutoff parameters, that define maximum request processing time of the transaction completion, can be passed in the header `X-Request-Deadline` of the corresponding request: ```  X-Request-Deadline: 10s ``` The system stops processing the request upon the specified time. It is recommended to specify a value that is not more than one minute and not less than three seconds. `X-Request-Deadline` can be:  * specified in the format `date-time` according to [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339); * specified in relative values: in milliseconds (`150000ms`), in seconds (`540s`) or in minutes (`3.5m`).
  *
- * The version of the OpenAPI document: 2.0.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/model/paymentStarted.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payment } from './payment';
+import { InvoiceChange } from './invoiceChange';
+export interface PaymentStarted extends InvoiceChange {
+    payment: Payment;
+}
+export declare namespace PaymentStarted {
+}

package/model/paymentStatus.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentError } from './paymentError';
+export interface PaymentStatus {
+    /**
+     * Payment status
+     */
+    status: PaymentStatus.StatusEnum;
+    error?: PaymentError;
+}
+export declare namespace PaymentStatus {
+    type StatusEnum = 'pending' | 'processed' | 'captured' | 'cancelled' | 'refunded' | 'failed';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Processed: StatusEnum;
+        Captured: StatusEnum;
+        Cancelled: StatusEnum;
+        Refunded: StatusEnum;
+        Failed: StatusEnum;
+    };
+}

package/model/paymentStatusChanged.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { InvoiceChange } from './invoiceChange';
+import { PaymentError } from './paymentError';
+export interface PaymentStatusChanged extends InvoiceChange {
+    /**
+     * Payment status
+     */
+    status: PaymentStatusChanged.StatusEnum;
+    error?: PaymentError;
+    paymentID: string;
+}
+export declare namespace PaymentStatusChanged {
+    type StatusEnum = 'pending' | 'processed' | 'captured' | 'cancelled' | 'refunded' | 'failed';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Processed: StatusEnum;
+        Captured: StatusEnum;
+        Cancelled: StatusEnum;
+        Refunded: StatusEnum;
+        Failed: StatusEnum;
+    };
+}

package/model/paymentTerminal.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentMethod } from './paymentMethod';
+export interface PaymentTerminal extends PaymentMethod {
+    /**
+     * Providers
+     */
+    providers: Array<string>;
+}
+export declare namespace PaymentTerminal {
+}

package/model/paymentTerminalData.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentTool } from './paymentTool';
+export interface PaymentTerminalData extends PaymentTool {
+    /**
+     * Payment terminal provider. The list of providers available for making payments can be found by calling the the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice. Additional provider details can be found out by calling [reference operation](#operation/getServiceProviderByID).
+     */
+    provider: string;
+    /**
+     * Arbitrary metadata further describing this payment instrument.
+     */
+    metadata?: object;
+}
+export declare namespace PaymentTerminalData {
+}

package/model/paymentTerminalDetails.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentTerminalDetails {
+    /**
+     * Payment terminal provider. The list of providers available for making payments can be found by calling the the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice. Additional provider details can be found out by calling [reference operation](#operation/getServiceProviderByID).
+     */
+    provider: string;
+}

package/model/paymentTerminalReceipt.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserInteraction } from './userInteraction';
+export interface PaymentTerminalReceipt extends UserInteraction {
+    /**
+     * Account number for payment via payment terminal
+     */
+    shortPaymentID: string;
+    /**
+     * Expiration date and time
+     */
+    dueDate: string;
+}

package/model/paymentTerms.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentTerms {
+    currencies?: Array<string>;
+    categories?: Array<number>;
+}

package/model/paymentTool.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentTool {
+    /**
+     * Payment tool type
+     */
+    paymentToolType: PaymentTool.PaymentToolTypeEnum;
+}
+export declare namespace PaymentTool {
+    type PaymentToolTypeEnum = 'CardData' | 'PaymentTerminalData' | 'DigitalWalletData' | 'TokenizedCardData' | 'CryptoWalletData' | 'MobileCommerceData';
+    const PaymentToolTypeEnum: {
+        CardData: PaymentToolTypeEnum;
+        PaymentTerminalData: PaymentToolTypeEnum;
+        DigitalWalletData: PaymentToolTypeEnum;
+        TokenizedCardData: PaymentToolTypeEnum;
+        CryptoWalletData: PaymentToolTypeEnum;
+        MobileCommerceData: PaymentToolTypeEnum;
+    };
+}

package/model/paymentToolDetails.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Payment tool details
+ */
+export interface PaymentToolDetails {
+    /**
+     * Type of payment tool
+     */
+    detailsType: string;
+}

package/model/paymentToolDetailsBankCard.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+export interface PaymentToolDetailsBankCard extends PaymentToolDetails {
+    /**
+     * Masked card number
+     */
+    cardNumberMask: string;
+    /**
+     * First digits of the card number. Absent for tokenized payment methods.
+     */
+    first6?: string;
+    /**
+     * Card last digits
+     */
+    last4?: string;
+    /**
+     * Payment system. The list of systems available for making payments can be found by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.
+     */
+    paymentSystem: string;
+    /**
+     * Payment token provider. The list of providers available for making payments can be found by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.
+     */
+    tokenProvider?: string;
+    /**
+     * Tokenization method
+     */
+    tokenizationMethod?: PaymentToolDetailsBankCard.TokenizationMethodEnum;
+}
+export declare namespace PaymentToolDetailsBankCard {
+    type TokenizationMethodEnum = 'dpan' | 'none';
+    const TokenizationMethodEnum: {
+        Dpan: TokenizationMethodEnum;
+        None: TokenizationMethodEnum;
+    };
+}

package/model/paymentToolDetailsCryptoWallet.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+export interface PaymentToolDetailsCryptoWallet extends PaymentToolDetails {
+    /**
+     * Cryptocurrency payment method. The list of cryptocurrencies available for making payments can be found out by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.
+     */
+    cryptoCurrency: string;
+}

package/model/paymentToolDetailsDigitalWallet.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+export interface PaymentToolDetailsDigitalWallet extends PaymentToolDetails {
+    /**
+     * E-wallet provider. The list of providers available for making payments can be found by calling the the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice. Additional provider details can be found out by calling [reference operation](#operation/getServiceProviderByID).
+     */
+    provider: string;
+}

package/model/paymentToolDetailsMobileCommerce.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+export interface PaymentToolDetailsMobileCommerce extends PaymentToolDetails {
+    /**
+     * Masked cell phone number
+     */
+    phoneNumber: string;
+}

package/model/paymentToolDetailsPaymentTerminal.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './paymentToolDetails';
+export interface PaymentToolDetailsPaymentTerminal extends PaymentToolDetails {
+    /**
+     * Payment terminal provider. The list of providers available for making payments can be found by calling the the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice. Additional provider details can be found out by calling [reference operation](#operation/getServiceProviderByID).
+     */
+    provider: string;
+}

package/model/powerOfAttorney.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { RepresentativeDocument } from './representativeDocument';
+export interface PowerOfAttorney extends RepresentativeDocument {
+    /**
+     * Legal agreement Identifier, e.g. contract number
+     */
+    id: string;
+    /**
+     * Date and time of conclusion of the legal agreement
+     */
+    signedAt: string;
+    /**
+     * Date and time of termination of the legal agreement
+     */
+    validUntil?: string;
+}
+export declare namespace PowerOfAttorney {
+}

package/model/privateEntity.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Contractor } from './contractor';
+/**
+ * Private entity
+ */
+export interface PrivateEntity extends Contractor {
+    /**
+     * Private entity type
+     */
+    entityType: PrivateEntity.EntityTypeEnum;
+}
+export declare namespace PrivateEntity {
+    type EntityTypeEnum = 'RussianPrivateEntity';
+    const EntityTypeEnum: {
+        RussianPrivateEntity: EntityTypeEnum;
+    };
+}

package/model/qrCodeDisplayRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserInteraction } from './userInteraction';
+export interface QrCodeDisplayRequest extends UserInteraction {
+    /**
+     * QR code content as byte array
+     */
+    qrCode: Blob;
+}

package/model/realmMode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Payment institution\'s mode
+ */
+export type RealmMode = 'test' | 'live';
+export declare const RealmMode: {
+    Test: RealmMode;
+    Live: RealmMode;
+};