@viu/emporix-sdk 2.21.0 → 2.23.0

package/dist/payment.d.cts

@@ -1,5 +1,94 @@
 import { C as ClientContext, b as AuthContext } from './context-CfXJcYKP.cjs';
 
+type PaymentModeRequest = {
+    /**
+     * Indicates a code of a given method.
+     */
+    code: string;
+    /**
+     * Indicates whether a give mode is active.
+     */
+    active?: boolean;
+    /**
+     * Indicates which provider should be used.
+     */
+    provider: Provider;
+    /**
+     * Map of configuration values for a particular gateway. Supported and required values for Spreedly:
+     * * `Spreedly/GatewayToken` - Indicates Spreedly gateway. Valid for `SPREEDLY`, `SPREEDLY_SAFERPAY`.
+     * * `Spreedly/EnvironmentKey` - Indicates Spreedly environment key. Valid for `SPREEDLY`, `SPREEDLY_SAFERPAY`.
+     * * `Spreedly/AccessSecret` - Indicates Spreedly access secret. Valid for `SPREEDLY`, `SPREEDLY_SAFERPAY`.
+     * * `Spreedly/PaymentMethodType` - Indicates payment method type, for example: paypal. Valid for `SPREEDLY`.
+     * * `Spreedly/RedirectURL` - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL. Valid for `SPREEDLY`.
+     * * `Spreedly/SignatureSecret` - Indicates a signature secret. The value is needed  for an offsite flow, when a confirmation callback is used. Valid for `SPREEDLY`.
+     * * `Spreedly/SCAProviderToken` - Indicates the Spreedly SCA (Strong Customer Authentication) provider token (3DS credit cart). Valid for `SPREEDLY`.
+     * * `Spreedly/ReceiverId` - Indicates the Spreedly Receiver identifier. Valid for `SPREEDLY_SAFERPAY`.
+     * * `Saferpay/BasicAuth` - Base64 encoded username and password of Saferpay account. Valid for `SPREEDLY_SAFERPAY`.
+     * * `Saferpay/CustomerId` - Saferpay customer ID. Valid for `SPREEDLY_SAFERPAY`.
+     * * `Saferpay/TerminalId` - Saferpay terminal ID. Valid for `SPREEDLY_SAFERPAY`.
+     * * `Saferpay/TestEnvironment` - Indicates if the configuration is done for test environment or a production one. If `true` then `https://test.saferpay.com` is used as a destination. Otherwise `https://www.saferpay.com` is used. Valid for `SPREEDLY_SAFERPAY`.
+     * * `Saferpay/RedirectUrl` - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL. Valid for `SPREEDLY_SAFERPAY`.
+     * * `Unzer/PaymentMethodType` - Indicates a payment method type. Currently supported value is `PAYLATER_INVOICE`. Valid for `UNZER`.
+     * * `Unzer/PublicKey` - Indicates a Unzer public key. Valid for `UNZER`.
+     * * `Unzer/PrivateKey` - Indicates a Unzer private key. Valid for `UNZER`.
+     * * `Unzer/CustomerType` - Indicates a customer type. Currently supported value is `B2C`. Valid for `UNZER`.
+     * requestBodies: { }
+     */
+    configuration?: {
+        [key: string]: string;
+    };
+};
+type PaymentMethodUpdateRequest = {
+    /**
+     * Indicates whether a give mode is active.
+     */
+    active?: boolean;
+    /**
+     * Map of configuration values for a particular gateway. Supported and required values for Spreedly:
+     * * `Spreedly/GatewayToken` - Indicates Spreedly gateway.
+     * * `Spreedly/EnvironmentKey` - Indicates Spreedly environment key.
+     * * `Spreedly/AccessSecret` - Indicates Spreedly access secret.
+     * * `Spreedly/PaymentMethodType` - Indicates payment method type, for example: paypal.
+     * * `Spreedly/RedirectURL` - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL.
+     * * `Spreedly/SignatureSecret` - Indicates a signature secret. The value is needed  for an offsite flow, when a confirmation callback is used.
+     * * `Spreedly/SCAProviderToken` - Indicates the Spreedly SCA (Strong Customer Authentication) provider token (3DS credit cart).
+     * requestBodies: { }
+     */
+    configuration?: {
+        [key: string]: string;
+    };
+};
+type Provider = 'INVOICE' | 'CASH_ON_DELIVERY' | 'SPREEDLY' | 'SPREEDLY_SAFERPAY' | 'UNZER';
+type PaymentModeResponse = {
+    /**
+     * Indicates an autogenerated identifier of a given payment method.
+     */
+    id?: string;
+    /**
+     * Indicates a code of a given method.
+     */
+    code?: string;
+    /**
+     * Indicates whether a give mode is active.
+     */
+    active?: boolean;
+    /**
+     * Indicates which provider should be used.
+     */
+    provider?: Provider;
+    /**
+     * Map of configuration values for a particular gateway. Supported and required values for Spreedly:
+     * * `Spreedly/GatewayToken` - Indicates Spreedly gateway.
+     * * `Spreedly/EnvironmentKey` - Indicates Spreedly environment key.
+     * * `Spreedly/AccessSecret` - Indicates Spreedly access secret.
+     * * `Spreedly/PaymentMethodType` - Indicates payment method type, for example: paypal.
+     * * `Spreedly/RedirectURL` - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL.
+     * * `Spreedly/SignatureSecret` - Indicates a signature secret. The value is needed  for an offsite flow, when a confirmation callback is used.
+     */
+    configuration?: {
+        [key: string]: string;
+    };
+};
 type PaymentModeFrontendResponse = {
     /**
      * Indicates an autogenerated identifier of a given payment method.
@@ -82,11 +171,176 @@ type AuthorizePaymentRequest = AuthorizeFrontendPaymentRequest & {
      */
     currency?: string;
 };
+type InitializePaymentResponse = {
+    /**
+     * Indicates if the authorization process finished with success.
+     */
+    successful?: boolean;
+    /**
+     * Unique payment transaction identifier.
+     */
+    paymentTransactionId?: string;
+    /**
+     * Authorization token
+     */
+    authorizationToken?: string;
+    /**
+     * Indicates a URL address where a user should be redirected in order to finish the authorization process.
+     */
+    externalPaymentRedirectURL?: string;
+    /**
+     * Indicates a HTTP Method which should be used in order to finish the authorization process.
+     */
+    externalPaymentHttpMethod?: string;
+    /**
+     * Map of additional parameters that may be needed in order to complete the authorization flow.
+     */
+    externalPaymentParameters?: {
+        [key: string]: string;
+    };
+};
+type AuthorizePaymentResponse = InitializePaymentResponse & {
+    /**
+     * Indicates if a redirect to an external site is required in order to finish the authorization flow.
+     */
+    requiresExternalPayment?: boolean;
+};
+type CaptureRequest = {
+    /**
+     * Amount that should be captured. The amount should not be greater than amount that was authorized.
+     */
+    amount?: number;
+    /**
+     * Currency for the amount that should be captured.
+     */
+    currency?: string;
+};
+type CommonPaymentResponse = {
+    /**
+     * Indicates if the operation finished with success or not.
+     */
+    successful?: boolean;
+    /**
+     * In case of failed operation, the field provides error details.
+     */
+    message?: string;
+};
+type RefundRequest = {
+    /**
+     * Amount that should be refunded. The amount should not be greater than amount that was captured.
+     */
+    amount?: number;
+    /**
+     * Currency for the amount that should be refunded.
+     */
+    currency?: string;
+    /**
+     * Capture identifier. The value is mandatory only if there were more captures for a payment and the refund should be related to a specific capture. In another case the value can be skipped and the capture related to the payment will be chosen automatically.
+     */
+    captureId?: string;
+};
+type PaymentTransactionResponse = {
+    /**
+     * A unique identifier of a payment transaction.
+     */
+    id?: string;
+    provider?: Provider;
+    /**
+     * Information related to a payment mode.
+     */
+    paymentInformation?: {
+        /**
+         * A unique identifier of a payment mode configured for the tenant.
+         */
+        paymentMode?: string;
+        /**
+         * Token of the credit card.
+         */
+        creditCardToken?: string;
+        /**
+         * Name of the card holder.
+         */
+        cardHolderName?: string;
+        /**
+         * URL for pay-by-link payment flow.
+         */
+        payByLinkURL?: string;
+        /**
+         * International Bank Account Number.
+         */
+        iban?: string;
+        /**
+         * Bank Identifier Code (SWIFT).
+         */
+        bic?: string;
+        /**
+         * SEPA mandate reference.
+         */
+        sepaMandateReference?: string;
+    };
+    /**
+     * List of transaction entries representing payment events.
+     */
+    entries?: Array<{
+        /**
+         * Unique identifier of a payment transaction entry.
+         */
+        id?: string;
+        /**
+         * Timestamp when the event happened.
+         */
+        createdDate?: string;
+        /**
+         * Event type.
+         */
+        type?: 'INITIALIZATION' | 'AUTHORIZATION' | 'CAPTURE' | 'REFUND' | 'CANCEL' | 'AUTHORIZATION_START' | 'AUTHORIZATION_CALLBACK';
+        /**
+         * Indicates if the event completed successfully.
+         */
+        successful?: boolean;
+        amount?: {
+            /**
+             * Amount related to the event.
+             */
+            amount?: number;
+            /**
+             * ISO currency code.
+             */
+            currency?: string;
+        };
+        /**
+         * Summary of the event.
+         */
+        summary?: string;
+        /**
+         * Serialized request body sent to payment provider.
+         */
+        remoteRequest?: string;
+        /**
+         * Serialized response body from payment provider.
+         */
+        remoteResponse?: string;
+        /**
+         * Remote token returned by payment provider.
+         */
+        remoteToken?: string;
+        /**
+         * Additional info about the transaction.
+         */
+        additionalInfo?: {
+            [key: string]: unknown;
+        };
+    }>;
+};
 
 /** A frontend payment mode (generated). */
 type PaymentMode = PaymentModeFrontendResponse;
 /** Post-checkout authorize request (generated; caller sends the exact wire shape). */
 type AuthorizePaymentInput = AuthorizePaymentRequest;
+/** Frontend payment-initialize request (generated). */
+type InitializePaymentInput = InitializePaymentRequest;
+/** Frontend payment-initialize response (generated). */
+type InitializePaymentResult = InitializePaymentResponse;
 /** Post-checkout authorize result. */
 interface AuthorizePaymentResult {
     successful: boolean;
@@ -97,6 +351,31 @@ interface AuthorizePaymentResult {
     externalPaymentHttpMethod?: string;
     [k: string]: unknown;
 }
+/** A configured payment mode (admin view, `/paymentmodes/config`). */
+type PaymentModeConfig = PaymentModeResponse;
+/** Body for creating a payment-mode configuration. */
+type PaymentModeCreateInput = PaymentModeRequest;
+/** Body for updating a payment-mode configuration. */
+type PaymentModeUpdateInput = PaymentMethodUpdateRequest;
+/** A payment transaction (generated). */
+type PaymentTransaction = PaymentTransactionResponse;
+/** Result of a backend payment authorization. */
+type PaymentAuthorizeResult = AuthorizePaymentResponse;
+/** Body for capturing an authorized payment. */
+type PaymentCaptureInput = CaptureRequest;
+/** Body for refunding a captured payment. */
+type PaymentRefundInput = RefundRequest;
+/**
+ * Result of a refund/cancel operation. Business failures are reported in the
+ * body (`successful: false` + `message`), not via HTTP status.
+ */
+type PaymentActionResult = CommonPaymentResponse;
+/** Result of a capture — like {@link PaymentActionResult} plus the provider's capture id. */
+type PaymentCaptureResult = {
+    successful?: boolean;
+    message?: string;
+    captureId?: string;
+};
 /** Payment-Gateway: list frontend payment modes, authorize deferred payments. */
 declare class PaymentGatewayService {
     private readonly ctx;
@@ -110,6 +389,61 @@ declare class PaymentGatewayService {
     listPaymentModes(authCtx?: AuthContext): Promise<PaymentMode[]>;
     /** Authorizes a post-checkout (deferred) payment for an existing order. */
     authorize(input: AuthorizePaymentInput, authCtx?: AuthContext): Promise<AuthorizePaymentResult>;
+    /** Retrieves a single frontend payment mode by id. Defaults to anonymous (no scope required). */
+    getMode(id: string, authCtx?: AuthContext): Promise<PaymentMode>;
+    /** Initializes a payment from the frontend. Defaults to anonymous (no scope required). */
+    initialize(input: InitializePaymentInput, authCtx?: AuthContext): Promise<InitializePaymentResult>;
+    /**
+     * Payment-mode **configuration** (`/paymentmodes/config`) — the admin view.
+     * For the storefront view use {@link listPaymentModes} / {@link getMode}.
+     * Defaults to service auth.
+     */
+    readonly modes: {
+        /** Lists all configured payment modes. The endpoint takes no query parameters. */
+        list: (authCtx?: AuthContext) => Promise<PaymentModeConfig[]>;
+        /** Retrieves one payment-mode configuration by id. */
+        get: (id: string, authCtx?: AuthContext) => Promise<PaymentModeConfig>;
+        /** Creates a payment-mode configuration. Responds 200 with the created mode. */
+        create: (input: PaymentModeCreateInput, authCtx?: AuthContext) => Promise<PaymentModeConfig>;
+        /** Updates a payment-mode configuration (PUT). Responds 200 with the updated mode. */
+        update: (id: string, input: PaymentModeUpdateInput, authCtx?: AuthContext) => Promise<PaymentModeConfig>;
+        /** Deletes a payment-mode configuration. */
+        delete: (id: string, authCtx?: AuthContext) => Promise<void>;
+    };
+    /**
+     * Backend transaction lifecycle and reads. `authorize` creates the transaction
+     * that `capture`/`refund`/`cancel` then act on. Business failures are reported
+     * in the response body (`successful: false`), not as HTTP errors — always check
+     * `successful`. Defaults to service auth.
+     */
+    readonly transactions: {
+        /** One page of payment transactions. */
+        list: (params?: {
+            pageNumber?: number;
+            pageSize?: number;
+            sort?: string;
+        }, authCtx?: AuthContext) => Promise<PaymentTransaction[]>;
+        /** Retrieves one payment transaction by id. */
+        get: (transactionId: string, authCtx?: AuthContext) => Promise<PaymentTransaction>;
+        /**
+         * Authorizes a payment as a backend caller (`POST /payment/authorize`). The
+         * storefront equivalent is {@link PaymentGatewayService.authorize}, which
+         * targets `/payment/frontend/authorize` with a customer token.
+         */
+        authorize: (input: AuthorizePaymentInput, authCtx?: AuthContext) => Promise<PaymentAuthorizeResult>;
+        /**
+         * Captures an authorized payment. Omit `input` to capture the full
+         * authorized amount. Returns the provider's `captureId` on success.
+         */
+        capture: (transactionId: string, input?: PaymentCaptureInput, authCtx?: AuthContext) => Promise<PaymentCaptureResult>;
+        /**
+         * Refunds a captured payment. Omit `input` to refund the full captured
+         * amount; pass `captureId` when several captures exist for the payment.
+         */
+        refund: (transactionId: string, input?: PaymentRefundInput, authCtx?: AuthContext) => Promise<PaymentActionResult>;
+        /** Cancels an authorized payment. Takes no body. */
+        cancel: (transactionId: string, authCtx?: AuthContext) => Promise<PaymentActionResult>;
+    };
 }
 
-export { type AuthorizePaymentInput, type AuthorizePaymentResult, PaymentGatewayService, type PaymentMode };
+export { type AuthorizePaymentInput, type AuthorizePaymentResult, type InitializePaymentInput, type InitializePaymentResult, type PaymentActionResult, type PaymentAuthorizeResult, type PaymentCaptureInput, type PaymentCaptureResult, PaymentGatewayService, type PaymentMode, type PaymentModeConfig, type PaymentModeCreateInput, type PaymentModeUpdateInput, type PaymentRefundInput, type PaymentTransaction };