@naturalpay/sdk 1.6.17 → 1.6.19

package/dist/esm/api/resources/paymentRequests/types/PayReqAttrs.d.mts

@@ -4,6 +4,8 @@ export interface PayReqAttrs {
     amount: number;
     /** Currency code. */
     currency: string;
+    /** Fee deducted from your proceeds as the recipient. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.ListPaymentRequestsResponseDataItemAttributesFee | null;
     /** Payment request status. */
     status: Natural.PayReqStatus;
     /** Whether the payer can still fulfill this request: it is OPEN, unexpired, and has no payment attempt. Does not check the payer's authorization or funding. */

package/dist/esm/api/resources/paymentRequests/types/PayReqDetailAttrs.d.mts

@@ -4,6 +4,8 @@ export interface PayReqDetailAttrs {
     amount: number;
     /** Currency code. */
     currency: string;
+    /** Fee deducted from your proceeds as the recipient. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.GetPaymentRequestsResponseDataAttributesFee | null;
     /** Payment request status. */
     status: Natural.PayReqDetailStatus;
     /** Whether the payer can still fulfill this request: it is OPEN, unexpired, and has no payment attempt. Does not check the payer's authorization or funding. */

package/dist/esm/api/resources/paymentRequests/types/index.d.mts

@@ -1,6 +1,10 @@
 export * from "./CancelPaymentRequestsResponse.mjs";
 export * from "./CancelPaymentRequestsResponseData.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributes.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributesPayerIdentifierType.mjs";
@@ -29,6 +33,10 @@ export * from "./CreatePaymentRequestsRequestPayerEmail.mjs";
 export * from "./CreatePaymentRequestsRequestPayerHandle.mjs";
 export * from "./CreatePaymentRequestsRequestPayerPartyId.mjs";
 export * from "./CreatePaymentRequestsRequestPayerPhone.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./CreatePaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./CreatePaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./CreatePaymentRequestsResponseDataRelationshipsPayerAgent.mjs";
@@ -51,6 +59,10 @@ export * from "./DeclinedReqStatus.mjs";
 export * from "./DeclinedReqWalletRef.mjs";
 export * from "./DeclinedReqWalletRefKind.mjs";
 export * from "./DeclinedReqWalletRel.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./DeclinePaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./DeclinePaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./DeclinePaymentRequestsResponseDataRelationshipsPayerAgent.mjs";
@@ -74,6 +86,10 @@ export * from "./FulfilledReqTxnRel.mjs";
 export * from "./FulfillPaymentRequestsRequestPaymentSource.mjs";
 export * from "./FulfillPaymentRequestsRequestPaymentSourceExternalAccount.mjs";
 export * from "./FulfillPaymentRequestsRequestPaymentSourceWallet.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestData.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestDataType.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsRecipientAgent.mjs";
@@ -87,6 +103,10 @@ export * from "./FulfillPaymentRequestsResponseDataRelationshipsSenderAgentDataT
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsSenderData.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsTransactionData.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsTransactionDataType.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./GetPaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./GetPaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./GetPaymentRequestsResponseDataRelationshipsPayerAgent.mjs";
@@ -113,6 +133,10 @@ export * from "./IncomingReqWalletRef.mjs";
 export * from "./IncomingReqWalletRefKind.mjs";
 export * from "./IncomingReqWalletRel.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItem.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFee.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesInitiatorAgent.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesInitiatorParty.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPayerAgent.mjs";
@@ -123,6 +147,10 @@ export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPayerPa
 export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPaymentData.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPaymentDataType.mjs";
 export * from "./ListPaymentRequestsResponseDataItem.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFee.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListPaymentRequestsResponseDataItemAttributesInitiatorAgent.mjs";
 export * from "./ListPaymentRequestsResponseDataItemAttributesInitiatorParty.mjs";
 export * from "./ListPaymentRequestsResponseDataItemRelationshipsPayerAgent.mjs";

package/dist/esm/api/resources/paymentRequests/types/index.mjs

@@ -1,6 +1,10 @@
 export * from "./CancelPaymentRequestsResponse.mjs";
 export * from "./CancelPaymentRequestsResponseData.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributes.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./CancelPaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./CancelPaymentRequestsResponseDataAttributesPayerIdentifierType.mjs";
@@ -29,6 +33,10 @@ export * from "./CreatePaymentRequestsRequestPayerEmail.mjs";
 export * from "./CreatePaymentRequestsRequestPayerHandle.mjs";
 export * from "./CreatePaymentRequestsRequestPayerPartyId.mjs";
 export * from "./CreatePaymentRequestsRequestPayerPhone.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./CreatePaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./CreatePaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./CreatePaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./CreatePaymentRequestsResponseDataRelationshipsPayerAgent.mjs";
@@ -51,6 +59,10 @@ export * from "./DeclinedReqStatus.mjs";
 export * from "./DeclinedReqWalletRef.mjs";
 export * from "./DeclinedReqWalletRefKind.mjs";
 export * from "./DeclinedReqWalletRel.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./DeclinePaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./DeclinePaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./DeclinePaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./DeclinePaymentRequestsResponseDataRelationshipsPayerAgent.mjs";
@@ -74,6 +86,10 @@ export * from "./FulfilledReqTxnRel.mjs";
 export * from "./FulfillPaymentRequestsRequestPaymentSource.mjs";
 export * from "./FulfillPaymentRequestsRequestPaymentSourceExternalAccount.mjs";
 export * from "./FulfillPaymentRequestsRequestPaymentSourceWallet.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestData.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestDataType.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsRecipientAgent.mjs";
@@ -87,6 +103,10 @@ export * from "./FulfillPaymentRequestsResponseDataRelationshipsSenderAgentDataT
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsSenderData.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsTransactionData.mjs";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsTransactionDataType.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFee.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFeeApplied.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFeeCurrency.mjs";
+export * from "./GetPaymentRequestsResponseDataAttributesFeePayer.mjs";
 export * from "./GetPaymentRequestsResponseDataAttributesInitiatorAgent.mjs";
 export * from "./GetPaymentRequestsResponseDataAttributesInitiatorParty.mjs";
 export * from "./GetPaymentRequestsResponseDataRelationshipsPayerAgent.mjs";
@@ -113,6 +133,10 @@ export * from "./IncomingReqWalletRef.mjs";
 export * from "./IncomingReqWalletRefKind.mjs";
 export * from "./IncomingReqWalletRel.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItem.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFee.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesInitiatorAgent.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemAttributesInitiatorParty.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPayerAgent.mjs";
@@ -123,6 +147,10 @@ export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPayerPa
 export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPaymentData.mjs";
 export * from "./ListIncomingPaymentRequestsResponseDataItemRelationshipsPaymentDataType.mjs";
 export * from "./ListPaymentRequestsResponseDataItem.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFee.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListPaymentRequestsResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListPaymentRequestsResponseDataItemAttributesInitiatorAgent.mjs";
 export * from "./ListPaymentRequestsResponseDataItemAttributesInitiatorParty.mjs";
 export * from "./ListPaymentRequestsResponseDataItemRelationshipsPayerAgent.mjs";

package/dist/esm/api/resources/payments/client/Client.d.mts

@@ -128,7 +128,8 @@ export declare class PaymentsClient {
      * @example
      *     await client.payments.cancel({
      *         idempotencyKey: "Idempotency-Key",
-     *         paymentId: "paymentId"
+     *         paymentId: "paymentId",
+     *         customerPartyId: "pty_019cd1798d627ad9bc302511c4f2c115"
      *     })
      */
     cancel(request: Natural.CancelPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.CancelledPmt>;

package/dist/esm/api/resources/payments/client/Client.mjs

@@ -63,9 +63,9 @@ export class PaymentsClient {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-                const { partyId, limit, cursor } = request;
+                const { customerPartyId, limit, cursor } = request;
                 const _queryParams = {
-                    partyId,
+                    customerPartyId,
                     limit,
                     cursor,
                 };
@@ -296,9 +296,9 @@ export class PaymentsClient {
     __get(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-            const { paymentId, partyId } = request;
+            const { paymentId, customerPartyId } = request;
             const _queryParams = {
-                partyId,
+                customerPartyId,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Instance-ID": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.instanceId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.instanceId }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -390,7 +390,8 @@ export class PaymentsClient {
      * @example
      *     await client.payments.cancel({
      *         idempotencyKey: "Idempotency-Key",
-     *         paymentId: "paymentId"
+     *         paymentId: "paymentId",
+     *         customerPartyId: "pty_019cd1798d627ad9bc302511c4f2c115"
      *     })
      */
     cancel(request, requestOptions) {
@@ -399,7 +400,7 @@ export class PaymentsClient {
     __cancel(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-            const { paymentId, idempotencyKey } = request;
+            const { paymentId, idempotencyKey } = request, _body = __rest(request, ["paymentId", "idempotencyKey"]);
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
                 "Idempotency-Key": idempotencyKey,
@@ -409,7 +410,13 @@ export class PaymentsClient {
                 url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.NaturalEnvironment.Production, `payments/${core.url.encodePathParam(paymentId)}/cancel`),
                 method: "POST",
                 headers: _headers,
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: mergeAdditionalBodyParameters(serializers.CancelPaymentsRequest.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
                 timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
                 maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/esm/api/resources/payments/client/requests/CancelPaymentsRequest.d.mts

@@ -2,11 +2,14 @@
  * @example
  *     {
  *         idempotencyKey: "Idempotency-Key",
- *         paymentId: "paymentId"
+ *         paymentId: "paymentId",
+ *         customerPartyId: "pty_019cd1798d627ad9bc302511c4f2c115"
  *     }
  */
 export interface CancelPaymentsRequest {
     paymentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
+    customerPartyId?: string;
 }

package/dist/esm/api/resources/payments/client/requests/GetPaymentsRequest.d.mts

@@ -6,5 +6,5 @@
  */
 export interface GetPaymentsRequest {
     paymentId: string;
-    partyId?: string;
+    customerPartyId?: string;
 }

package/dist/esm/api/resources/payments/client/requests/ListPaymentsRequest.d.mts

@@ -3,7 +3,7 @@
  *     {}
  */
 export interface ListPaymentsRequest {
-    partyId?: string;
+    customerPartyId?: string;
     limit?: number;
     cursor?: string;
 }

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface CancelPaymentsResponseDataAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.CancelPaymentsResponseDataAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.CancelPaymentsResponseDataAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.CancelPaymentsResponseDataAttributesFeeApplied;
+}

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const CancelPaymentsResponseDataAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type CancelPaymentsResponseDataAttributesFeeApplied = (typeof CancelPaymentsResponseDataAttributesFeeApplied)[keyof typeof CancelPaymentsResponseDataAttributesFeeApplied];

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const CancelPaymentsResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const CancelPaymentsResponseDataAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type CancelPaymentsResponseDataAttributesFeeCurrency = (typeof CancelPaymentsResponseDataAttributesFeeCurrency)[keyof typeof CancelPaymentsResponseDataAttributesFeeCurrency];

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const CancelPaymentsResponseDataAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const CancelPaymentsResponseDataAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type CancelPaymentsResponseDataAttributesFeePayer = (typeof CancelPaymentsResponseDataAttributesFeePayer)[keyof typeof CancelPaymentsResponseDataAttributesFeePayer];

package/dist/esm/api/resources/payments/types/CancelPaymentsResponseDataAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const CancelPaymentsResponseDataAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/payments/types/CancelledPmtAttrs.d.mts

@@ -10,6 +10,8 @@ export interface CancelledPmtAttrs {
     description: string | null;
     /** Metadata visible to anyone who can read the resource. */
     tags: Record<string, string>;
+    /** Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CancelPaymentsResponseDataAttributesFee | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface CreatePaymentsResponseDataAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.CreatePaymentsResponseDataAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.CreatePaymentsResponseDataAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.CreatePaymentsResponseDataAttributesFeeApplied;
+}

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const CreatePaymentsResponseDataAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type CreatePaymentsResponseDataAttributesFeeApplied = (typeof CreatePaymentsResponseDataAttributesFeeApplied)[keyof typeof CreatePaymentsResponseDataAttributesFeeApplied];

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const CreatePaymentsResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const CreatePaymentsResponseDataAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type CreatePaymentsResponseDataAttributesFeeCurrency = (typeof CreatePaymentsResponseDataAttributesFeeCurrency)[keyof typeof CreatePaymentsResponseDataAttributesFeeCurrency];

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const CreatePaymentsResponseDataAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const CreatePaymentsResponseDataAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type CreatePaymentsResponseDataAttributesFeePayer = (typeof CreatePaymentsResponseDataAttributesFeePayer)[keyof typeof CreatePaymentsResponseDataAttributesFeePayer];

package/dist/esm/api/resources/payments/types/CreatePaymentsResponseDataAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const CreatePaymentsResponseDataAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface GetPaymentsResponseDataAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.GetPaymentsResponseDataAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.GetPaymentsResponseDataAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.GetPaymentsResponseDataAttributesFeeApplied;
+}

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const GetPaymentsResponseDataAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type GetPaymentsResponseDataAttributesFeeApplied = (typeof GetPaymentsResponseDataAttributesFeeApplied)[keyof typeof GetPaymentsResponseDataAttributesFeeApplied];

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const GetPaymentsResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const GetPaymentsResponseDataAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type GetPaymentsResponseDataAttributesFeeCurrency = (typeof GetPaymentsResponseDataAttributesFeeCurrency)[keyof typeof GetPaymentsResponseDataAttributesFeeCurrency];

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const GetPaymentsResponseDataAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const GetPaymentsResponseDataAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type GetPaymentsResponseDataAttributesFeePayer = (typeof GetPaymentsResponseDataAttributesFeePayer)[keyof typeof GetPaymentsResponseDataAttributesFeePayer];

package/dist/esm/api/resources/payments/types/GetPaymentsResponseDataAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const GetPaymentsResponseDataAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFee.d.mts

@@ -0,0 +1,11 @@
+import type * as Natural from "../../../index.mjs";
+export interface ListPaymentsResponseDataItemAttributesFee {
+    /** Fee amount in cents. */
+    amount: number;
+    /** Currency of the fee. */
+    currency: Natural.ListPaymentsResponseDataItemAttributesFeeCurrency;
+    /** Party role charged the fee. */
+    payer: Natural.ListPaymentsResponseDataItemAttributesFeePayer;
+    /** The fee is added to the sender's cost without reducing the principal amount. */
+    applied: Natural.ListPaymentsResponseDataItemAttributesFeeApplied;
+}

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFeeApplied.d.mts

@@ -0,0 +1,5 @@
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export declare const ListPaymentsResponseDataItemAttributesFeeApplied: {
+    readonly OnTop: "on_top";
+};
+export type ListPaymentsResponseDataItemAttributesFeeApplied = (typeof ListPaymentsResponseDataItemAttributesFeeApplied)[keyof typeof ListPaymentsResponseDataItemAttributesFeeApplied];

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFeeApplied.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** The fee is added to the sender's cost without reducing the principal amount. */
+export const ListPaymentsResponseDataItemAttributesFeeApplied = {
+    OnTop: "on_top",
+};

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFeeCurrency.d.mts

@@ -0,0 +1,5 @@
+/** Currency of the fee. */
+export declare const ListPaymentsResponseDataItemAttributesFeeCurrency: {
+    readonly Usd: "USD";
+};
+export type ListPaymentsResponseDataItemAttributesFeeCurrency = (typeof ListPaymentsResponseDataItemAttributesFeeCurrency)[keyof typeof ListPaymentsResponseDataItemAttributesFeeCurrency];

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFeeCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency of the fee. */
+export const ListPaymentsResponseDataItemAttributesFeeCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFeePayer.d.mts

@@ -0,0 +1,5 @@
+/** Party role charged the fee. */
+export declare const ListPaymentsResponseDataItemAttributesFeePayer: {
+    readonly Sender: "sender";
+};
+export type ListPaymentsResponseDataItemAttributesFeePayer = (typeof ListPaymentsResponseDataItemAttributesFeePayer)[keyof typeof ListPaymentsResponseDataItemAttributesFeePayer];

package/dist/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFeePayer.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Party role charged the fee. */
+export const ListPaymentsResponseDataItemAttributesFeePayer = {
+    Sender: "sender",
+};

package/dist/esm/api/resources/payments/types/NewPaymentAttrs.d.mts

@@ -10,6 +10,8 @@ export interface NewPaymentAttrs {
     description: string | null;
     /** Metadata visible to anyone who can read the resource. */
     tags: Record<string, string>;
+    /** Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CreatePaymentsResponseDataAttributesFee | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/payments/types/PaymentAttrs.d.mts

@@ -10,6 +10,8 @@ export interface PaymentAttrs {
     description: string | null;
     /** Metadata visible to anyone who can read the resource. */
     tags: Record<string, string>;
+    /** Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.ListPaymentsResponseDataItemAttributesFee | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/payments/types/PaymentDetailAttrs.d.mts

@@ -10,6 +10,8 @@ export interface PaymentDetailAttrs {
     description: string | null;
     /** Metadata visible to anyone who can read the resource. */
     tags: Record<string, string>;
+    /** Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.GetPaymentsResponseDataAttributesFee | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/payments/types/index.d.mts

@@ -9,6 +9,10 @@ export * from "./CancelledPmtSenderRefKind.mjs";
 export * from "./CancelledPmtSenderRel.mjs";
 export * from "./CancelledPmtStatus.mjs";
 export * from "./CancelledPmtTxnRel.mjs";
+export * from "./CancelPaymentsResponseDataAttributesFee.mjs";
+export * from "./CancelPaymentsResponseDataAttributesFeeApplied.mjs";
+export * from "./CancelPaymentsResponseDataAttributesFeeCurrency.mjs";
+export * from "./CancelPaymentsResponseDataAttributesFeePayer.mjs";
 export * from "./CancelPaymentsResponseDataRelationshipsPaymentRequestData.mjs";
 export * from "./CancelPaymentsResponseDataRelationshipsPaymentRequestDataType.mjs";
 export * from "./CancelPaymentsResponseDataRelationshipsRecipientAgent.mjs";
@@ -29,6 +33,10 @@ export * from "./CreatePaymentsRequestCounterpartyHandle.mjs";
 export * from "./CreatePaymentsRequestCounterpartyPartyId.mjs";
 export * from "./CreatePaymentsRequestCounterpartyPhone.mjs";
 export * from "./CreatePaymentsRequestDisableNotificationsItem.mjs";
+export * from "./CreatePaymentsResponseDataAttributesFee.mjs";
+export * from "./CreatePaymentsResponseDataAttributesFeeApplied.mjs";
+export * from "./CreatePaymentsResponseDataAttributesFeeCurrency.mjs";
+export * from "./CreatePaymentsResponseDataAttributesFeePayer.mjs";
 export * from "./CreatePaymentsResponseDataRelationshipsPaymentRequestData.mjs";
 export * from "./CreatePaymentsResponseDataRelationshipsPaymentRequestDataType.mjs";
 export * from "./CreatePaymentsResponseDataRelationshipsRecipientAgent.mjs";
@@ -42,6 +50,10 @@ export * from "./CreatePaymentsResponseDataRelationshipsSenderAgentDataType.mjs"
 export * from "./CreatePaymentsResponseDataRelationshipsSenderData.mjs";
 export * from "./CreatePaymentsResponseDataRelationshipsTransactionData.mjs";
 export * from "./CreatePaymentsResponseDataRelationshipsTransactionDataType.mjs";
+export * from "./GetPaymentsResponseDataAttributesFee.mjs";
+export * from "./GetPaymentsResponseDataAttributesFeeApplied.mjs";
+export * from "./GetPaymentsResponseDataAttributesFeeCurrency.mjs";
+export * from "./GetPaymentsResponseDataAttributesFeePayer.mjs";
 export * from "./GetPaymentsResponseDataRelationshipsPaymentRequestData.mjs";
 export * from "./GetPaymentsResponseDataRelationshipsPaymentRequestDataType.mjs";
 export * from "./GetPaymentsResponseDataRelationshipsRecipientAgent.mjs";
@@ -56,6 +68,10 @@ export * from "./GetPaymentsResponseDataRelationshipsSenderData.mjs";
 export * from "./GetPaymentsResponseDataRelationshipsTransactionData.mjs";
 export * from "./GetPaymentsResponseDataRelationshipsTransactionDataType.mjs";
 export * from "./ListPaymentsResponseDataItem.mjs";
+export * from "./ListPaymentsResponseDataItemAttributesFee.mjs";
+export * from "./ListPaymentsResponseDataItemAttributesFeeApplied.mjs";
+export * from "./ListPaymentsResponseDataItemAttributesFeeCurrency.mjs";
+export * from "./ListPaymentsResponseDataItemAttributesFeePayer.mjs";
 export * from "./ListPaymentsResponseDataItemRelationshipsPaymentRequestData.mjs";
 export * from "./ListPaymentsResponseDataItemRelationshipsPaymentRequestDataType.mjs";
 export * from "./ListPaymentsResponseDataItemRelationshipsRecipientAgent.mjs";