@wix/auto_sdk_payments_psp-callbacks 1.0.0

package/build/internal/es/src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.d.ts

@@ -0,0 +1,137 @@
+/** Provider platform event */
+export interface ProviderPlatformEvent extends ProviderPlatformEventResourceOneOf {
+    /** Refund event data. */
+    refund?: RefundEvent;
+    /** Transaction event data. */
+    transaction?: TransactionEvent;
+    /** Capture event data */
+    capture?: CaptureEvent;
+    /** Void event data */
+    void?: VoidEvent;
+    /**
+     * This field is ignored, do not send it.
+     * @deprecated
+     */
+    pluginId?: string;
+}
+/** @oneof */
+export interface ProviderPlatformEventResourceOneOf {
+    /** Refund event data. */
+    refund?: RefundEvent;
+    /** Transaction event data. */
+    transaction?: TransactionEvent;
+    /** Capture event data */
+    capture?: CaptureEvent;
+    /** Void event data */
+    void?: VoidEvent;
+}
+export interface RefundEvent {
+    /** Wix transaction ID. */
+    wixTransactionId?: string;
+    /** PSP refund ID. */
+    pluginRefundId?: string;
+    /** Wix [reason code](https://dev.wix.com/api/rest/all-apis/provider-platform/reason-codes#all-apis_provider-platform_reason-codes_refund-declined) indicating a failed request. */
+    reasonCode?: number;
+    /** Refunded amount. */
+    amount?: string;
+    /** Wix refund ID. This field is only required when a merchant initiates a refund from the Wix dashboard. */
+    wixRefundId?: string | null;
+    /** PSP-specific error code. */
+    errorCode?: string | null;
+    /** PSP-specific error message. */
+    errorMessage?: string | null;
+}
+export interface TransactionEvent {
+    /** Wix transaction ID. */
+    wixTransactionId?: string;
+    /** PSP transaction ID. */
+    pluginTransactionId?: string;
+    /** Wix [reason code](https://dev.wix.com/api/rest/all-apis/provider-platform/reason-codes) indicating a failed or pending request. */
+    reasonCode?: number;
+    /** PSP-specific error code. */
+    errorCode?: string | null;
+    /** PSP-specific error message. */
+    errorMessage?: string | null;
+    /** Token data for stored payment method. */
+    credentialsOnFile?: CredentialsOnFile;
+    /** Details of actual customer's card, obtained from a Funding PAN as opposed to a Device PAN. */
+    cardDetails?: CardDetails;
+}
+export interface CredentialsOnFile extends CredentialsOnFileInfoOneOf {
+    /** Network token data. */
+    cardReference?: CardReference;
+    /** Provider generated token data. */
+    paymentMethodReference?: PaymentMethodReference;
+}
+/** @oneof */
+export interface CredentialsOnFileInfoOneOf {
+    /** Network token data. */
+    cardReference?: CardReference;
+    /** Provider generated token data. */
+    paymentMethodReference?: PaymentMethodReference;
+}
+export interface CardReference {
+    /** Network token. */
+    networkTransactionId?: string;
+    /** Directory Server transaction ID */
+    dsTransactionId?: string | null;
+}
+export interface PaymentMethodReference {
+    /** Payment method token created by the PSP. */
+    token?: string;
+}
+export interface CardDetails {
+    /** Issuer (business) identification number. First 6 or 8 digits of the card's number. */
+    bin?: string | null;
+    /** Last 4 digits of the card's number. */
+    lastFour?: string | null;
+}
+export interface CaptureEvent {
+    /** Wix transaction ID. */
+    wixTransactionId?: string;
+    /** Wix [reason code](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes#capture-declined) indicating request's status. */
+    reasonCode?: number;
+    /** Capture amount. */
+    amount?: string;
+    /** PSP-specific error code. */
+    errorCode?: string | null;
+    /** PSP-specific error message. */
+    errorMessage?: string | null;
+}
+export interface VoidEvent {
+    /** Wix transaction ID. */
+    wixTransactionId?: string;
+    /** PSP void ID. */
+    reasonCode?: number;
+    /** Voided amount. */
+    amount?: string;
+    /** PSP-specific error code. */
+    errorCode?: string | null;
+    /** PSP-specific error message. */
+    errorMessage?: string | null;
+}
+/** Submit event request */
+export interface SubmitEventRequest {
+    /** Event data. */
+    event: ProviderPlatformEvent;
+}
+/** Submit event response */
+export interface SubmitEventResponse {
+}
+/**
+ * This Wix API is used by a Payment Service Provider (PSP) to send webhooks about payment and refund states to Wix.
+ *
+ * Calls to this endpoint must include a `User-Agent` header with the name of the PSP and the integration version in this format: `{PSP}/{version}`.
+ * PSP's create their own version numbers.
+ *
+ * > You cannot try out this endpoint because an `Authorization` header value has to be obtained
+ * > with the OAuth 2.0 client credentials flow for a specific scope.
+ * > So please ignore the **Authorization** section below as well as the **Try It Out** button.
+ * @param event - Event data.
+ * @public
+ * @requiredField event
+ * @permissionId CASHIER.GET_ACCESS
+ * @returns Submit event response
+ * @fqn wix.payments.v1.provider_platform_events.ProviderPlatformEventsService.SubmitEvent
+ */
+export declare function submitEvent(event: ProviderPlatformEvent): Promise<void>;

package/build/internal/es/src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.js

@@ -0,0 +1,40 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixPaymentsPspV1ProviderPlatformEvent from './payments-psp-v1-provider-platform-event-psp-callbacks.http.js';
+/**
+ * This Wix API is used by a Payment Service Provider (PSP) to send webhooks about payment and refund states to Wix.
+ *
+ * Calls to this endpoint must include a `User-Agent` header with the name of the PSP and the integration version in this format: `{PSP}/{version}`.
+ * PSP's create their own version numbers.
+ *
+ * > You cannot try out this endpoint because an `Authorization` header value has to be obtained
+ * > with the OAuth 2.0 client credentials flow for a specific scope.
+ * > So please ignore the **Authorization** section below as well as the **Try It Out** button.
+ * @param event - Event data.
+ * @public
+ * @requiredField event
+ * @permissionId CASHIER.GET_ACCESS
+ * @returns Submit event response
+ * @fqn wix.payments.v1.provider_platform_events.ProviderPlatformEventsService.SubmitEvent
+ */
+export async function submitEvent(event) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({ event: event });
+    const reqOpts = ambassadorWixPaymentsPspV1ProviderPlatformEvent.submitEvent(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { event: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['event']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=payments-psp-v1-provider-platform-event-psp-callbacks.universal.js.map

package/build/internal/es/src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments-psp-v1-provider-platform-event-psp-callbacks.universal.js","sourceRoot":"","sources":["../../../../src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAEhG,OAAO,KAAK,+CAA+C,MAAM,iEAAiE,CAAC;AAuInI;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,KAA4B;IAC5D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAExE,MAAM,OAAO,GACX,+CAA+C,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;YAC3C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,OAAO,CAAC,CACV,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_payments_psp-callbacks",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35",
+    "@wix/sdk-types": "^1.12.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-payments-psp-callbacks",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "pspCallbacks",
+      "fqdn": "wix.payments.psp.v1.provider_platform_event"
+    }
+  },
+  "falconPackageHash": "1bdc124665fb6bc564ae06faa6b2e6e7814acecb4a70b20fab733330"
+}