@naturalpay/sdk 1.6.20 → 1.6.21

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFee.d.ts

@@ -0,0 +1,15 @@
+import type * as Natural from "../../../../api/index.js";
+import * as core from "../../../../core/index.js";
+import type * as serializers from "../../../index.js";
+import { ListWireResponseDataItemAttributesFeeApplied } from "./ListWireResponseDataItemAttributesFeeApplied.js";
+import { ListWireResponseDataItemAttributesFeeCurrency } from "./ListWireResponseDataItemAttributesFeeCurrency.js";
+import { ListWireResponseDataItemAttributesFeePayer } from "./ListWireResponseDataItemAttributesFeePayer.js";
+export declare const ListWireResponseDataItemAttributesFee: core.serialization.ObjectSchema<serializers.ListWireResponseDataItemAttributesFee.Raw, Natural.ListWireResponseDataItemAttributesFee>;
+export declare namespace ListWireResponseDataItemAttributesFee {
+    interface Raw {
+        amount: number;
+        currency: ListWireResponseDataItemAttributesFeeCurrency.Raw;
+        payer: ListWireResponseDataItemAttributesFeePayer.Raw;
+        applied: ListWireResponseDataItemAttributesFeeApplied.Raw;
+    }
+}

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFee.js

@@ -0,0 +1,47 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListWireResponseDataItemAttributesFee = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+const ListWireResponseDataItemAttributesFeeApplied_js_1 = require("./ListWireResponseDataItemAttributesFeeApplied.js");
+const ListWireResponseDataItemAttributesFeeCurrency_js_1 = require("./ListWireResponseDataItemAttributesFeeCurrency.js");
+const ListWireResponseDataItemAttributesFeePayer_js_1 = require("./ListWireResponseDataItemAttributesFeePayer.js");
+exports.ListWireResponseDataItemAttributesFee = core.serialization.object({
+    amount: core.serialization.number(),
+    currency: ListWireResponseDataItemAttributesFeeCurrency_js_1.ListWireResponseDataItemAttributesFeeCurrency,
+    payer: ListWireResponseDataItemAttributesFeePayer_js_1.ListWireResponseDataItemAttributesFeePayer,
+    applied: ListWireResponseDataItemAttributesFeeApplied_js_1.ListWireResponseDataItemAttributesFeeApplied,
+});

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFeeApplied.d.ts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../../api/index.js";
+import * as core from "../../../../core/index.js";
+import type * as serializers from "../../../index.js";
+export declare const ListWireResponseDataItemAttributesFeeApplied: core.serialization.Schema<serializers.ListWireResponseDataItemAttributesFeeApplied.Raw, Natural.ListWireResponseDataItemAttributesFeeApplied>;
+export declare namespace ListWireResponseDataItemAttributesFeeApplied {
+    type Raw = "on_top";
+}

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFeeApplied.js

@@ -0,0 +1,39 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListWireResponseDataItemAttributesFeeApplied = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+exports.ListWireResponseDataItemAttributesFeeApplied = core.serialization.enum_(["on_top"]);

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFeeCurrency.d.ts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../../api/index.js";
+import * as core from "../../../../core/index.js";
+import type * as serializers from "../../../index.js";
+export declare const ListWireResponseDataItemAttributesFeeCurrency: core.serialization.Schema<serializers.ListWireResponseDataItemAttributesFeeCurrency.Raw, Natural.ListWireResponseDataItemAttributesFeeCurrency>;
+export declare namespace ListWireResponseDataItemAttributesFeeCurrency {
+    type Raw = "USD";
+}

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFeeCurrency.js

@@ -0,0 +1,39 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListWireResponseDataItemAttributesFeeCurrency = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+exports.ListWireResponseDataItemAttributesFeeCurrency = core.serialization.enum_(["USD"]);

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFeePayer.d.ts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../../api/index.js";
+import * as core from "../../../../core/index.js";
+import type * as serializers from "../../../index.js";
+export declare const ListWireResponseDataItemAttributesFeePayer: core.serialization.Schema<serializers.ListWireResponseDataItemAttributesFeePayer.Raw, Natural.ListWireResponseDataItemAttributesFeePayer>;
+export declare namespace ListWireResponseDataItemAttributesFeePayer {
+    type Raw = "sender";
+}

package/dist/cjs/serialization/resources/wire/types/ListWireResponseDataItemAttributesFeePayer.js

@@ -0,0 +1,39 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListWireResponseDataItemAttributesFeePayer = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+exports.ListWireResponseDataItemAttributesFeePayer = core.serialization.enum_(["sender"]);

package/dist/cjs/serialization/resources/wire/types/index.d.ts

@@ -3,6 +3,10 @@ export * from "./CancelWireResponseData.js";
 export * from "./CancelWireResponseDataAttributes.js";
 export * from "./CancelWireResponseDataAttributesCurrency.js";
 export * from "./CancelWireResponseDataAttributesFailure.js";
+export * from "./CancelWireResponseDataAttributesFee.js";
+export * from "./CancelWireResponseDataAttributesFeeApplied.js";
+export * from "./CancelWireResponseDataAttributesFeeCurrency.js";
+export * from "./CancelWireResponseDataAttributesFeePayer.js";
 export * from "./CancelWireResponseDataAttributesStatus.js";
 export * from "./CancelWireResponseDataRelationships.js";
 export * from "./CancelWireResponseDataRelationshipsCustomerParty.js";
@@ -24,6 +28,10 @@ export * from "./CreateWireResponseData.js";
 export * from "./CreateWireResponseDataAttributes.js";
 export * from "./CreateWireResponseDataAttributesCurrency.js";
 export * from "./CreateWireResponseDataAttributesFailure.js";
+export * from "./CreateWireResponseDataAttributesFee.js";
+export * from "./CreateWireResponseDataAttributesFeeApplied.js";
+export * from "./CreateWireResponseDataAttributesFeeCurrency.js";
+export * from "./CreateWireResponseDataAttributesFeePayer.js";
 export * from "./CreateWireResponseDataAttributesStatus.js";
 export * from "./CreateWireResponseDataRelationships.js";
 export * from "./CreateWireResponseDataRelationshipsCustomerParty.js";
@@ -44,6 +52,10 @@ export * from "./GetWireResponseData.js";
 export * from "./GetWireResponseDataAttributes.js";
 export * from "./GetWireResponseDataAttributesCurrency.js";
 export * from "./GetWireResponseDataAttributesFailure.js";
+export * from "./GetWireResponseDataAttributesFee.js";
+export * from "./GetWireResponseDataAttributesFeeApplied.js";
+export * from "./GetWireResponseDataAttributesFeeCurrency.js";
+export * from "./GetWireResponseDataAttributesFeePayer.js";
 export * from "./GetWireResponseDataAttributesStatus.js";
 export * from "./GetWireResponseDataRelationships.js";
 export * from "./GetWireResponseDataRelationshipsCustomerParty.js";
@@ -65,6 +77,10 @@ export * from "./ListWireResponseDataItem.js";
 export * from "./ListWireResponseDataItemAttributes.js";
 export * from "./ListWireResponseDataItemAttributesCurrency.js";
 export * from "./ListWireResponseDataItemAttributesFailure.js";
+export * from "./ListWireResponseDataItemAttributesFee.js";
+export * from "./ListWireResponseDataItemAttributesFeeApplied.js";
+export * from "./ListWireResponseDataItemAttributesFeeCurrency.js";
+export * from "./ListWireResponseDataItemAttributesFeePayer.js";
 export * from "./ListWireResponseDataItemAttributesStatus.js";
 export * from "./ListWireResponseDataItemRelationships.js";
 export * from "./ListWireResponseDataItemRelationshipsCustomerParty.js";

package/dist/cjs/serialization/resources/wire/types/index.js

@@ -19,6 +19,10 @@ __exportStar(require("./CancelWireResponseData.js"), exports);
 __exportStar(require("./CancelWireResponseDataAttributes.js"), exports);
 __exportStar(require("./CancelWireResponseDataAttributesCurrency.js"), exports);
 __exportStar(require("./CancelWireResponseDataAttributesFailure.js"), exports);
+__exportStar(require("./CancelWireResponseDataAttributesFee.js"), exports);
+__exportStar(require("./CancelWireResponseDataAttributesFeeApplied.js"), exports);
+__exportStar(require("./CancelWireResponseDataAttributesFeeCurrency.js"), exports);
+__exportStar(require("./CancelWireResponseDataAttributesFeePayer.js"), exports);
 __exportStar(require("./CancelWireResponseDataAttributesStatus.js"), exports);
 __exportStar(require("./CancelWireResponseDataRelationships.js"), exports);
 __exportStar(require("./CancelWireResponseDataRelationshipsCustomerParty.js"), exports);
@@ -40,6 +44,10 @@ __exportStar(require("./CreateWireResponseData.js"), exports);
 __exportStar(require("./CreateWireResponseDataAttributes.js"), exports);
 __exportStar(require("./CreateWireResponseDataAttributesCurrency.js"), exports);
 __exportStar(require("./CreateWireResponseDataAttributesFailure.js"), exports);
+__exportStar(require("./CreateWireResponseDataAttributesFee.js"), exports);
+__exportStar(require("./CreateWireResponseDataAttributesFeeApplied.js"), exports);
+__exportStar(require("./CreateWireResponseDataAttributesFeeCurrency.js"), exports);
+__exportStar(require("./CreateWireResponseDataAttributesFeePayer.js"), exports);
 __exportStar(require("./CreateWireResponseDataAttributesStatus.js"), exports);
 __exportStar(require("./CreateWireResponseDataRelationships.js"), exports);
 __exportStar(require("./CreateWireResponseDataRelationshipsCustomerParty.js"), exports);
@@ -60,6 +68,10 @@ __exportStar(require("./GetWireResponseData.js"), exports);
 __exportStar(require("./GetWireResponseDataAttributes.js"), exports);
 __exportStar(require("./GetWireResponseDataAttributesCurrency.js"), exports);
 __exportStar(require("./GetWireResponseDataAttributesFailure.js"), exports);
+__exportStar(require("./GetWireResponseDataAttributesFee.js"), exports);
+__exportStar(require("./GetWireResponseDataAttributesFeeApplied.js"), exports);
+__exportStar(require("./GetWireResponseDataAttributesFeeCurrency.js"), exports);
+__exportStar(require("./GetWireResponseDataAttributesFeePayer.js"), exports);
 __exportStar(require("./GetWireResponseDataAttributesStatus.js"), exports);
 __exportStar(require("./GetWireResponseDataRelationships.js"), exports);
 __exportStar(require("./GetWireResponseDataRelationshipsCustomerParty.js"), exports);
@@ -81,6 +93,10 @@ __exportStar(require("./ListWireResponseDataItem.js"), exports);
 __exportStar(require("./ListWireResponseDataItemAttributes.js"), exports);
 __exportStar(require("./ListWireResponseDataItemAttributesCurrency.js"), exports);
 __exportStar(require("./ListWireResponseDataItemAttributesFailure.js"), exports);
+__exportStar(require("./ListWireResponseDataItemAttributesFee.js"), exports);
+__exportStar(require("./ListWireResponseDataItemAttributesFeeApplied.js"), exports);
+__exportStar(require("./ListWireResponseDataItemAttributesFeeCurrency.js"), exports);
+__exportStar(require("./ListWireResponseDataItemAttributesFeePayer.js"), exports);
 __exportStar(require("./ListWireResponseDataItemAttributesStatus.js"), exports);
 __exportStar(require("./ListWireResponseDataItemRelationships.js"), exports);
 __exportStar(require("./ListWireResponseDataItemRelationshipsCustomerParty.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.6.20";
+export declare const SDK_VERSION = "1.6.21";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.6.20";
+exports.SDK_VERSION = "1.6.21";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@naturalpay/sdk",
-        "X-Fern-SDK-Version": "1.6.20",
-        "User-Agent": "@naturalpay/sdk/1.6.20",
+        "X-Fern-SDK-Version": "1.6.21",
+        "User-Agent": "@naturalpay/sdk/1.6.21",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Instance-ID": options === null || options === void 0 ? void 0 : options.instanceId,

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

@@ -67,6 +67,7 @@ export declare class AchClient {
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
      *         companyEntryDescription: "PAYOUT",
+     *         internalDescription: "July contractor payout, ledger 1042",
      *         addenda: "Invoice 1042, July services"
      *     })
      */

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

@@ -193,6 +193,7 @@ export class AchClient {
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
      *         companyEntryDescription: "PAYOUT",
+     *         internalDescription: "July contractor payout, ledger 1042",
      *         addenda: "Invoice 1042, July services"
      *     })
      */

package/dist/esm/api/resources/ach/client/requests/NewAchParams.d.mts

@@ -8,6 +8,7 @@ import type * as Natural from "../../../../index.mjs";
  *         currency: "USD",
  *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
  *         companyEntryDescription: "PAYOUT",
+ *         internalDescription: "July contractor payout, ledger 1042",
  *         addenda: "Invoice 1042, July services"
  *     }
  */
@@ -16,20 +17,22 @@ export interface NewAchParams {
     idempotencyKey: string;
     /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
-    /** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+    /** Direction of the payment. */
     direction: Natural.NewAchParamsDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. Defaults to USD. */
     currency?: Natural.NewAchParamsCurrency;
-    /** Wallet (wal_*) to debit or credit. Defaults to the party's default wallet. */
+    /** Wallet (wal_*) to fund the payment. Defaults to the party's default wallet. */
     walletId?: string;
-    /** External party account (epa_*) to pay or debit. */
+    /** External party account (epa_*) to pay. */
     externalPartyAccountId: string;
     /** Mandate (mdt_*) authorizing the debit. Required for debits; not allowed for credits. */
     mandateId?: string;
-    /** ACH company entry description. Maximum 10 characters. */
+    /** ACH company entry description. Delivered to the receiving bank on the entry. Maximum 10 characters. */
     companyEntryDescription: string;
+    /** Description for your internal reference. Never shared with the counterparty or the banking network. Maximum 255 characters. */
+    internalDescription?: string;
     /** Payment-related information carried to the receiving bank as the NACHA addenda record. Maximum 80 characters. */
     addenda?: string;
 }

package/dist/esm/api/resources/ach/types/AchAttrs.d.mts

@@ -1,17 +1,19 @@
 import type * as Natural from "../../../index.mjs";
 export interface AchAttrs {
-    /** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+    /** Direction of the payment. */
     direction: Natural.AchDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. */
     currency: Natural.AchCurrency;
-    /** Fee added to your cost as the sender for an ACH credit. Null for ACH debits, when no fee applies, the fee was voided, or your party is not the fee payer. */
+    /** 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.ListAchResponseDataItemAttributesFee | null;
     /** ACH payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, RETURNED, or CANCELED end it. */
     status: Natural.AchStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
     addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */

package/dist/esm/api/resources/ach/types/AchDetailAttrs.d.mts

@@ -1,17 +1,19 @@
 import type * as Natural from "../../../index.mjs";
 export interface AchDetailAttrs {
-    /** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+    /** Direction of the payment. */
     direction: Natural.AchDetailDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. */
     currency: Natural.AchDetailCurrency;
-    /** Fee added to your cost as the sender for an ACH credit. Null for ACH debits, when no fee applies, the fee was voided, or your party is not the fee payer. */
+    /** 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.GetAchResponseDataAttributesFee | null;
     /** ACH payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, RETURNED, or CANCELED end it. */
     status: Natural.AchDetailStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
     addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */

package/dist/esm/api/resources/ach/types/AchDetailDirection.d.mts

@@ -1,4 +1,4 @@
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export declare const AchDetailDirection: {
     readonly Debit: "debit";
     readonly Credit: "credit";

package/dist/esm/api/resources/ach/types/AchDetailDirection.mjs

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export const AchDetailDirection = {
     Debit: "debit",
     Credit: "credit",

package/dist/esm/api/resources/ach/types/AchDetailExtPartyRel.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * External party paid or debited.
+ * External party the payment is with.
  */
 export interface AchDetailExtPartyRel {
     /** Related resource identifier. */

package/dist/esm/api/resources/ach/types/AchDetailRels.d.mts

@@ -2,9 +2,9 @@ import type * as Natural from "../../../index.mjs";
 export interface AchDetailRels {
     /** Party the payment was created for. */
     customerParty: Natural.AchDetailCustomerPartyRel;
-    /** Wallet the payment debits or credits. */
+    /** Wallet used for this payment. */
     wallet: Natural.AchDetailWalletRel;
-    /** External party paid or debited. */
+    /** External party the payment is with. */
     externalParty: Natural.AchDetailExtPartyRel;
     /** External party account used. */
     externalPartyAccount: Natural.AchDetailExtPartyAcctRel;

package/dist/esm/api/resources/ach/types/AchDetailWalletRel.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Wallet the payment debits or credits.
+ * Wallet used for this payment.
  */
 export interface AchDetailWalletRel {
     /** Related resource identifier. */

package/dist/esm/api/resources/ach/types/AchDirection.d.mts

@@ -1,4 +1,4 @@
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export declare const AchDirection: {
     readonly Debit: "debit";
     readonly Credit: "credit";

package/dist/esm/api/resources/ach/types/AchDirection.mjs

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export const AchDirection = {
     Debit: "debit",
     Credit: "credit",

package/dist/esm/api/resources/ach/types/AchExtPartyRel.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * External party paid or debited.
+ * External party the payment is with.
  */
 export interface AchExtPartyRel {
     /** Related resource identifier. */

package/dist/esm/api/resources/ach/types/AchRels.d.mts

@@ -2,9 +2,9 @@ import type * as Natural from "../../../index.mjs";
 export interface AchRels {
     /** Party the payment was created for. */
     customerParty: Natural.AchCustomerPartyRel;
-    /** Wallet the payment debits or credits. */
+    /** Wallet used for this payment. */
     wallet: Natural.AchWalletRel;
-    /** External party paid or debited. */
+    /** External party the payment is with. */
     externalParty: Natural.AchExtPartyRel;
     /** External party account used. */
     externalPartyAccount: Natural.AchExtPartyAcctRel;

package/dist/esm/api/resources/ach/types/AchWalletRel.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Wallet the payment debits or credits.
+ * Wallet used for this payment.
  */
 export interface AchWalletRel {
     /** Related resource identifier. */

package/dist/esm/api/resources/ach/types/CancelledAchAttrs.d.mts

@@ -1,17 +1,19 @@
 import type * as Natural from "../../../index.mjs";
 export interface CancelledAchAttrs {
-    /** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+    /** Direction of the payment. */
     direction: Natural.CancelledAchDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. */
     currency: Natural.CancelledAchCurrency;
-    /** Fee added to your cost as the sender for an ACH credit. Null for ACH debits, when no fee applies, the fee was voided, or your party is not the fee payer. */
+    /** 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.CancelAchResponseDataAttributesFee | null;
     /** ACH payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, RETURNED, or CANCELED end it. */
     status: Natural.CancelledAchStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
     addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */

package/dist/esm/api/resources/ach/types/CancelledAchDirection.d.mts

@@ -1,4 +1,4 @@
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export declare const CancelledAchDirection: {
     readonly Debit: "debit";
     readonly Credit: "credit";

package/dist/esm/api/resources/ach/types/CancelledAchDirection.mjs

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export const CancelledAchDirection = {
     Debit: "debit",
     Credit: "credit",

package/dist/esm/api/resources/ach/types/CancelledAchExtPartyRel.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * External party paid or debited.
+ * External party the payment is with.
  */
 export interface CancelledAchExtPartyRel {
     /** Related resource identifier. */

package/dist/esm/api/resources/ach/types/CancelledAchRels.d.mts

@@ -2,9 +2,9 @@ import type * as Natural from "../../../index.mjs";
 export interface CancelledAchRels {
     /** Party the payment was created for. */
     customerParty: Natural.CancelledAchCustomerPartyRel;
-    /** Wallet the payment debits or credits. */
+    /** Wallet used for this payment. */
     wallet: Natural.CancelledAchWalletRel;
-    /** External party paid or debited. */
+    /** External party the payment is with. */
     externalParty: Natural.CancelledAchExtPartyRel;
     /** External party account used. */
     externalPartyAccount: Natural.CancelledAchExtPartyAcctRel;

package/dist/esm/api/resources/ach/types/CancelledAchWalletRel.d.mts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Wallet the payment debits or credits.
+ * Wallet used for this payment.
  */
 export interface CancelledAchWalletRel {
     /** Related resource identifier. */

package/dist/esm/api/resources/ach/types/NewAchAttrs.d.mts

@@ -1,17 +1,19 @@
 import type * as Natural from "../../../index.mjs";
 export interface NewAchAttrs {
-    /** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+    /** Direction of the payment. */
     direction: Natural.NewAchDirection;
     /** Amount in cents. */
     amount: number;
     /** Currency code. */
     currency: Natural.NewAchCurrency;
-    /** Fee added to your cost as the sender for an ACH credit. Null for ACH debits, when no fee applies, the fee was voided, or your party is not the fee payer. */
+    /** 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.CreateAchResponseDataAttributesFee | null;
     /** ACH payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, RETURNED, or CANCELED end it. */
     status: Natural.NewAchStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
     addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */

package/dist/esm/api/resources/ach/types/NewAchDirection.d.mts

@@ -1,4 +1,4 @@
-/** `debit` pulls funds from the external account into your wallet; `credit` pushes funds from your wallet to it. */
+/** Direction of the payment. */
 export declare const NewAchDirection: {
     readonly Debit: "debit";
     readonly Credit: "credit";