@vality/swag-payments 0.1.0

package/lib/model/payment-params.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payer } from './payer';
+import { PaymentFlow } from './payment-flow';
+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/lib/model/payment-recurrent-parent.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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).
+ * 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/lib/model/payment-resource-client-info.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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).
+ * 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/lib/model/payment-resource-params.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentTool } from './payment-tool';
+import { ClientInfo } from './client-info';
+export interface PaymentResourceParams {
+    paymentTool: PaymentTool;
+    clientInfo: ClientInfo;
+}

package/lib/model/payment-resource-payer-all-of.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ContactInfo } from './contact-info';
+export interface PaymentResourcePayerAllOf {
+    contactInfo: ContactInfo;
+}

package/lib/model/payment-resource-payer.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payer } from './payer';
+import { PaymentToolDetails } from './payment-tool-details';
+import { ContactInfo } from './contact-info';
+import { PaymentResourceClientInfo } from './payment-resource-client-info';
+/**
+ * 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/lib/model/payment-resource-result.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './payment-tool-details';
+import { PaymentResourceClientInfo } from './payment-resource-client-info';
+/**
+ * Disposable payment tool data
+ */
+export interface PaymentResourceResult {
+    /**
+     * Payment tool token provided by the payer
+     */
+    paymentToolToken: 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/payment-resource.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentToolDetails } from './payment-tool-details';
+import { PaymentResourceClientInfo } from './payment-resource-client-info';
+/**
+ * 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/lib/model/payment-search-result-all-of.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payer } from './payer';
+import { InvoiceLine } from './invoice-line';
+import { AllocationTransaction } from './allocation-transaction';
+import { PaymentFlow } from './payment-flow';
+import { TransactionInfo } from './transaction-info';
+export interface PaymentSearchResultAllOf {
+    /**
+     * Payment ID
+     */
+    id: string;
+    /**
+     * Shortened payment and invoice identifier (spid)
+     */
+    shortID?: string;
+    /**
+     * Identifier of the invoice within which the payment was created
+     */
+    invoiceID: string;
+    /**
+     * Identifier of the shop within which the payment was created
+     */
+    shopID?: string;
+    /**
+     * Created at
+     */
+    createdAt: string;
+    /**
+     * The price of the goods or services offered, in minor monetary units, e.g. cents if U.S. dollars are specified as the currency
+     */
+    amount: number;
+    /**
+     * System fee in minor monetary units
+     */
+    fee?: number;
+    /**
+     * Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
+     */
+    currency: string;
+    payer: Payer;
+    flow: PaymentFlow;
+    /**
+     * Payment metadata
+     */
+    metadata?: object;
+    /**
+     * Date and time of payment status change
+     */
+    statusChangedAt?: string;
+    transactionInfo?: TransactionInfo;
+    /**
+     * 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;
+    /**
+     * Products and services cart
+     */
+    cart?: Array<InvoiceLine>;
+    /**
+     * Allocation of cash
+     */
+    allocation?: Array<AllocationTransaction>;
+}

package/lib/model/payment-search-result.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payer } from './payer';
+import { InvoiceLine } from './invoice-line';
+import { AllocationTransaction } from './allocation-transaction';
+import { PaymentFlow } from './payment-flow';
+import { TransactionInfo } from './transaction-info';
+import { PaymentError } from './payment-error';
+export interface PaymentSearchResult {
+    /**
+     * Payment status
+     */
+    status: PaymentSearchResult.StatusEnum;
+    error?: PaymentError;
+    /**
+     * Payment ID
+     */
+    id: string;
+    /**
+     * Shortened payment and invoice identifier (spid)
+     */
+    shortID?: string;
+    /**
+     * Identifier of the invoice within which the payment was created
+     */
+    invoiceID: string;
+    /**
+     * Identifier of the shop within which the payment was created
+     */
+    shopID?: string;
+    /**
+     * Created at
+     */
+    createdAt: string;
+    /**
+     * The price of the goods or services offered, in minor monetary units, e.g. cents if U.S. dollars are specified as the currency
+     */
+    amount: number;
+    /**
+     * System fee in minor monetary units
+     */
+    fee?: number;
+    /**
+     * Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
+     */
+    currency: string;
+    payer: Payer;
+    flow: PaymentFlow;
+    /**
+     * Payment metadata
+     */
+    metadata?: object;
+    /**
+     * Date and time of payment status change
+     */
+    statusChangedAt?: string;
+    transactionInfo?: TransactionInfo;
+    /**
+     * 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;
+    /**
+     * Products and services cart
+     */
+    cart?: Array<InvoiceLine>;
+    /**
+     * Allocation of cash
+     */
+    allocation?: Array<AllocationTransaction>;
+}
+export declare namespace PaymentSearchResult {
+    type StatusEnum = 'pending' | 'processed' | 'captured' | 'cancelled' | 'refunded' | 'failed';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Processed: StatusEnum;
+        Captured: StatusEnum;
+        Cancelled: StatusEnum;
+        Refunded: StatusEnum;
+        Failed: StatusEnum;
+    };
+}

package/lib/model/payment-started-all-of.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payment } from './payment';
+export interface PaymentStartedAllOf {
+    payment: Payment;
+}

package/lib/model/payment-started.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Payment } from './payment';
+import { InvoiceChange } from './invoice-change';
+export interface PaymentStarted extends InvoiceChange {
+    payment: Payment;
+}
+export declare namespace PaymentStarted {
+}

package/lib/model/payment-status-changed-all-of.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentStatusChangedAllOf {
+    paymentID: string;
+}

package/lib/model/payment-status-changed.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { InvoiceChange } from './invoice-change';
+import { PaymentError } from './payment-error';
+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/lib/model/payment-status.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentError } from './payment-error';
+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/lib/model/payment-terminal-all-of.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentTerminalAllOf {
+    /**
+     * Providers
+     */
+    providers: Array<string>;
+}

package/lib/model/payment-terminal-data-all-of.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Payment terminal
+ */
+export interface PaymentTerminalDataAllOf {
+    /**
+     * 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;
+}

package/lib/model/payment-terminal-data.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentTool } from './payment-tool';
+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/lib/model/payment-terminal-details.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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).
+ * 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/lib/model/payment-terminal-receipt-all-of.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PaymentTerminalReceiptAllOf {
+    /**
+     * Account number for payment via payment terminal
+     */
+    shortPaymentID: string;
+    /**
+     * Expiration date and time
+     */
+    dueDate: string;
+}