@commercetools/checkout-sdk 1.0.0

package/dist/declarations/src/generated/models/payment-intents.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { Amount } from "./common.js";
+export interface PaymentIntent {
+    /**
+     *	Action to execute for the given Payment.
+     *
+     *
+     */
+    readonly actions: PaymentIntentAction[];
+}
+/**
+ *	Depending on the action specified, Checkout requests the [payment service provider](/connectors-and-applications#supported-psps-payment-integration-types-and-payment-methods) (PSP) or gift card management system to capture, refund, or cancel the authorization for the given Payment.
+ *
+ */
+export type PaymentIntentAction = PaymentIntentCancelAction | PaymentIntentCaptureAction | PaymentIntentRefundAction | PaymentIntentReverseAction;
+export interface IPaymentIntentAction {
+    /**
+     *	Action to execute for the given [Payment](/../api/projects/payments#payment).
+     *
+     *
+     */
+    readonly action: PaymentIntentOperation;
+}
+/**
+ *	Requests to [cancel the authorization](/payments-lifecycle#authorization-cancellation) for a Payment. Checkout will cancel the [Payment](/../api/projects/payments#payment) and will request the PSP or gift card management system to proceed with the financial process to cancel the authorization.
+ *
+ *	You cannot request to cancel the authorization for a Payment that has already been [captured](/payments-lifecycle#payment-capture).
+ *
+ */
+export interface PaymentIntentCancelAction extends IPaymentIntentAction {
+    readonly action: 'cancelPayment';
+    /**
+     *	A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.
+     *
+     *
+     */
+    readonly merchantReference?: string;
+}
+/**
+ *	Requests to [capture](/payments-lifecycle#payment-capture) the given amount from the customer. Checkout will request the PSP or gift card management system to proceed with the financial process to capture the amount.
+ *
+ */
+export interface PaymentIntentCaptureAction extends IPaymentIntentAction {
+    readonly action: 'capturePayment';
+    /**
+     *	Amount to be captured. It must be less than or equal to the [authorized](/payments-lifecycle#authorization) amount.
+     *
+     *
+     */
+    readonly amount: Amount;
+    /**
+     *	A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.
+     *
+     *
+     */
+    readonly merchantReference?: string;
+}
+/**
+ *	The possible values for a [Payment Intent Action](ctp:checkout:type:PaymentIntentAction).
+ *
+ */
+export declare enum PaymentIntentOperationValues {
+    CancelPayment = "cancelPayment",
+    CapturePayment = "capturePayment",
+    RefundPayment = "refundPayment",
+    ReversePayment = "reversePayment"
+}
+export type PaymentIntentOperation = 'cancelPayment' | 'capturePayment' | 'refundPayment' | 'reversePayment' | (string & {});
+/**
+ *	Requests to [refund](/payments-lifecycle#refund) the given amount to the customer. Checkout will request the PSP or gift card management system to proceed with the financial process to refund the amount.
+ *
+ */
+export interface PaymentIntentRefundAction extends IPaymentIntentAction {
+    readonly action: 'refundPayment';
+    /**
+     *	Amount to be refunded. It must be less than or equal to the [captured](/payments-lifecycle#payment-capture) amount.
+     *
+     *
+     */
+    readonly amount: Amount;
+    /**
+     *	The identifier of the capture transaction that is associated with the refund action.
+     *
+     *
+     */
+    readonly transactionId?: string;
+    /**
+     *	A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.
+     *
+     *
+     */
+    readonly merchantReference?: string;
+}
+/**
+ *	Requests to [reverse](/payment-integration-predicates) a [Payment](/../api/projects/payments#payment). Checkout reverses the Payment, and then requests the PSP or gift card management system to proceed with the relevant process to reverse the Payment.
+ *
+ */
+export interface PaymentIntentReverseAction extends IPaymentIntentAction {
+    readonly action: 'reversePayment';
+    /**
+     *	A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.
+     *
+     *
+     */
+    readonly merchantReference?: string;
+}
+//# sourceMappingURL=payment-intents.d.ts.map

package/dist/declarations/src/generated/models/payment-intents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-intents.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["payment-intents.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,oBAAgB;AAEjC,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,EAAE,CAAA;CACxC;AACD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B,yBAAyB,GACzB,0BAA0B,GAC1B,yBAAyB,GACzB,0BAA0B,CAAA;AAC9B,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAA;CACxC;AACD;;;;;GAKG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CACpC;AACD;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;CAClC;AAED,MAAM,MAAM,sBAAsB,GAC9B,eAAe,GACf,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AACjB;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CACpC"}

package/dist/declarations/src/generated/models/payment.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { IReference, IResourceIdentifier } from "./common.js";
+/**
+ *	Reference to a [Payment](/../api/projects/payments).
+ *
+ */
+export interface PaymentReference extends IReference {
+    readonly typeId: 'payment';
+    /**
+     *	Unique identifier of the referenced [Payment](/../api/projects/payments).
+     *
+     *
+     */
+    readonly id: string;
+}
+/**
+ *	Resource identifier to a [Payment](/../api/projects/payments). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/errors#invalidjsoninput) error is returned.
+ *
+ */
+export interface PaymentResourceIdentifier extends IResourceIdentifier {
+    readonly typeId: 'payment';
+    /**
+     *	Unique identifier of the referenced [Payment](/../api/projects/payments). Required if `key` is absent.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	User-defined unique identifier of the referenced [Payment](/../api/projects/payments). Required if `id` is absent.
+     *
+     *
+     */
+    readonly key?: string;
+}
+//# sourceMappingURL=payment.d.ts.map

package/dist/declarations/src/generated/models/payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["payment.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,oBAAgB;AAE1D;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CACpB;AACD;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB"}