@wix/auto_sdk_payments_psp-callbacks 1.0.0

package/build/cjs/src/payments-psp-v1-provider-platform-event-psp-callbacks.types.d.ts

@@ -0,0 +1,120 @@
+/** 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 {
+}

package/build/cjs/src/payments-psp-v1-provider-platform-event-psp-callbacks.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=payments-psp-v1-provider-platform-event-psp-callbacks.types.js.map

package/build/cjs/src/payments-psp-v1-provider-platform-event-psp-callbacks.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments-psp-v1-provider-platform-event-psp-callbacks.types.js","sourceRoot":"","sources":["../../../src/payments-psp-v1-provider-platform-event-psp-callbacks.types.ts"],"names":[],"mappings":""}

package/build/cjs/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/cjs/src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.js

@@ -0,0 +1,67 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.submitEvent = void 0;
+const transform_error_1 = require("@wix/sdk-runtime/transform-error");
+const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
+const ambassadorWixPaymentsPspV1ProviderPlatformEvent = __importStar(require("./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
+ */
+async function submitEvent(event) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ event: event });
+    const reqOpts = ambassadorWixPaymentsPspV1ProviderPlatformEvent.submitEvent(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = (0, transform_error_1.transformError)(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { event: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['event']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+exports.submitEvent = submitEvent;
+//# sourceMappingURL=payments-psp-v1-provider-platform-event-psp-callbacks.universal.js.map

package/build/cjs/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,sEAAuF;AACvF,oFAAgG;AAEhG,iJAAmI;AAuInI;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,WAAW,CAAC,KAA4B;IAC5D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,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,IAAA,gCAAiB,EACxC,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;AA9BD,kCA8BC"}

package/build/es/index.d.ts

@@ -0,0 +1 @@
+export * from './src/payments-psp-v1-provider-platform-event-psp-callbacks.context.js';

package/build/es/index.js

@@ -0,0 +1,2 @@
+export * from './src/payments-psp-v1-provider-platform-event-psp-callbacks.context.js';
+//# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,wEAAwE,CAAC"}

package/build/es/index.typings.d.ts

@@ -0,0 +1 @@
+export * from './src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.js';

package/build/es/index.typings.js

@@ -0,0 +1,2 @@
+export * from './src/payments-psp-v1-provider-platform-event-psp-callbacks.universal.js';
+//# sourceMappingURL=index.typings.js.map

package/build/es/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":"AAAA,cAAc,0EAA0E,CAAC"}

package/build/es/meta.d.ts

@@ -0,0 +1 @@
+export * from './src/payments-psp-v1-provider-platform-event-psp-callbacks.meta.js';

package/build/es/meta.js

@@ -0,0 +1,2 @@
+export * from './src/payments-psp-v1-provider-platform-event-psp-callbacks.meta.js';
+//# sourceMappingURL=meta.js.map

package/build/es/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,cAAc,qEAAqE,CAAC"}

package/build/es/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

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

@@ -0,0 +1,4 @@
+import { submitEvent as publicSubmitEvent } from './payments-psp-v1-provider-platform-event-psp-callbacks.public.js';
+import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
+export declare const submitEvent: MaybeContext<BuildRESTFunction<typeof publicSubmitEvent> & typeof publicSubmitEvent>;
+export { ProviderPlatformEvent, ProviderPlatformEventResourceOneOf, RefundEvent, TransactionEvent, CredentialsOnFile, CredentialsOnFileInfoOneOf, CardReference, PaymentMethodReference, CardDetails, CaptureEvent, VoidEvent, SubmitEventRequest, SubmitEventResponse, } from './payments-psp-v1-provider-platform-event-psp-callbacks.universal.js';

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

@@ -0,0 +1,4 @@
+import { submitEvent as publicSubmitEvent } from './payments-psp-v1-provider-platform-event-psp-callbacks.public.js';
+import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
+export const submitEvent = /*#__PURE__*/ createRESTModule(publicSubmitEvent);
+//# sourceMappingURL=payments-psp-v1-provider-platform-event-psp-callbacks.context.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payments-psp-v1-provider-platform-event-psp-callbacks.context.js","sourceRoot":"","sources":["../../../src/payments-psp-v1-provider-platform-event-psp-callbacks.context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,IAAI,iBAAiB,EAAE,MAAM,mEAAmE,CAAC;AACrH,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGjE,MAAM,CAAC,MAAM,WAAW,GAEpB,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC"}

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

@@ -0,0 +1,12 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+/**
+ * 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.
+ */
+export declare function submitEvent(payload: object): RequestOptionsFactory<any>;