npm - @naturalpay/sdk - Versions diffs - 1.6.19 → 1.6.21 - Mend

@naturalpay/sdk 1.6.19 → 1.6.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (788) hide show

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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";

package/dist/esm/api/resources/ach/types/NewAchDirection.mjs CHANGED Viewed

@@ -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 NewAchDirection = {
     Debit: "debit",
     Credit: "credit",

package/dist/esm/api/resources/ach/types/NewAchExtPartyRel.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/ach/types/NewAchParamsDirection.d.mts CHANGED Viewed

@@ -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 NewAchParamsDirection: {
     readonly Debit: "debit";
     readonly Credit: "credit";

package/dist/esm/api/resources/ach/types/NewAchParamsDirection.mjs CHANGED Viewed

@@ -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 NewAchParamsDirection = {
     Debit: "debit",
     Credit: "credit",

package/dist/esm/api/resources/ach/types/NewAchRels.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/ach/types/NewAchWalletRel.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesAch.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 export interface ApproveApprovalsResponseDataAttributesAch {
-    /** `debit` pulls funds from the counterparty account; `credit` pushes funds to it. */
+    /** Direction of the payment. */
     direction: Natural.ApproveApprovalsResponseDataAttributesAchDirection;
     /** ACH SEC code the entry is submitted under. */
     secCode: Natural.ApproveApprovalsResponseDataAttributesAchSecCode;
@@ -8,6 +8,8 @@ export interface ApproveApprovalsResponseDataAttributesAch {
     companyEntryDescription: string;
     /** Payment-related information submitted as the NACHA addenda record, or null. */
     addenda: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesAchCounterparty.d.mts CHANGED Viewed

@@ -1,11 +1,11 @@
 import type * as Natural from "../../../index.mjs";
 export interface ApproveApprovalsResponseDataAttributesAchCounterparty {
-    /** External party being paid or debited (epty_*). */
+    /** External party being paid (epty_*). */
     externalPartyId: string;
     /** External party display or legal name. */
     name: string;
     /** External party type. */
     kind: Natural.ApproveApprovalsResponseDataAttributesAchCounterpartyKind;
-    /** Masked bank account the ACH debits or credits. */
+    /** Masked bank account the ACH payment uses. */
     account: Natural.ApproveApprovalsResponseDataAttributesAchCounterpartyAccount;
 }

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesAchCounterpartyAccount.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Masked bank account the ACH debits or credits.
+ * Masked bank account the ACH payment uses.
  */
 export interface ApproveApprovalsResponseDataAttributesAchCounterpartyAccount {
     /** External party account (epa_*). */

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesAchDirection.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesAchDirection.mjs CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesCheck.d.mts CHANGED Viewed

@@ -9,4 +9,6 @@ export interface ApproveApprovalsResponseDataAttributesCheck {
     amount: number;
     /** Memo printed on the check. */
     memo: string;
+    /** Description for the sender's internal reference, or null. Never printed on the check or shared with the counterparty. */
+    internalDescription: string | null;
 }

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesRealtime.d.mts CHANGED Viewed

@@ -2,6 +2,8 @@ import type * as Natural from "../../../index.mjs";
 export interface ApproveApprovalsResponseDataAttributesRealtime {
     /** Description supplied when the payment was created. */
     description: string;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.ApproveApprovalsResponseDataAttributesRealtimeCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesWire.d.mts CHANGED Viewed

@@ -4,6 +4,8 @@ export interface ApproveApprovalsResponseDataAttributesWire {
     description: string;
     /** Remittance information, or null. */
     remittanceInfo: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.ApproveApprovalsResponseDataAttributesWireCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesAch.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 export interface DenyApprovalsResponseDataAttributesAch {
-    /** `debit` pulls funds from the counterparty account; `credit` pushes funds to it. */
+    /** Direction of the payment. */
     direction: Natural.DenyApprovalsResponseDataAttributesAchDirection;
     /** ACH SEC code the entry is submitted under. */
     secCode: Natural.DenyApprovalsResponseDataAttributesAchSecCode;
@@ -8,6 +8,8 @@ export interface DenyApprovalsResponseDataAttributesAch {
     companyEntryDescription: string;
     /** Payment-related information submitted as the NACHA addenda record, or null. */
     addenda: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesAchCounterparty.d.mts CHANGED Viewed

@@ -1,11 +1,11 @@
 import type * as Natural from "../../../index.mjs";
 export interface DenyApprovalsResponseDataAttributesAchCounterparty {
-    /** External party being paid or debited (epty_*). */
+    /** External party being paid (epty_*). */
     externalPartyId: string;
     /** External party display or legal name. */
     name: string;
     /** External party type. */
     kind: Natural.DenyApprovalsResponseDataAttributesAchCounterpartyKind;
-    /** Masked bank account the ACH debits or credits. */
+    /** Masked bank account the ACH payment uses. */
     account: Natural.DenyApprovalsResponseDataAttributesAchCounterpartyAccount;
 }

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesAchCounterpartyAccount.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Masked bank account the ACH debits or credits.
+ * Masked bank account the ACH payment uses.
  */
 export interface DenyApprovalsResponseDataAttributesAchCounterpartyAccount {
     /** External party account (epa_*). */

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesAchDirection.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesAchDirection.mjs CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesCheck.d.mts CHANGED Viewed

@@ -9,4 +9,6 @@ export interface DenyApprovalsResponseDataAttributesCheck {
     amount: number;
     /** Memo printed on the check. */
     memo: string;
+    /** Description for the sender's internal reference, or null. Never printed on the check or shared with the counterparty. */
+    internalDescription: string | null;
 }

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesRealtime.d.mts CHANGED Viewed

@@ -2,6 +2,8 @@ import type * as Natural from "../../../index.mjs";
 export interface DenyApprovalsResponseDataAttributesRealtime {
     /** Description supplied when the payment was created. */
     description: string;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.DenyApprovalsResponseDataAttributesRealtimeCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/DenyApprovalsResponseDataAttributesWire.d.mts CHANGED Viewed

@@ -4,6 +4,8 @@ export interface DenyApprovalsResponseDataAttributesWire {
     description: string;
     /** Remittance information, or null. */
     remittanceInfo: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.DenyApprovalsResponseDataAttributesWireCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesAch.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 export interface GetApprovalsResponseDataAttributesAch {
-    /** `debit` pulls funds from the counterparty account; `credit` pushes funds to it. */
+    /** Direction of the payment. */
     direction: Natural.GetApprovalsResponseDataAttributesAchDirection;
     /** ACH SEC code the entry is submitted under. */
     secCode: Natural.GetApprovalsResponseDataAttributesAchSecCode;
@@ -8,6 +8,8 @@ export interface GetApprovalsResponseDataAttributesAch {
     companyEntryDescription: string;
     /** Payment-related information submitted as the NACHA addenda record, or null. */
     addenda: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesAchCounterparty.d.mts CHANGED Viewed

@@ -1,11 +1,11 @@
 import type * as Natural from "../../../index.mjs";
 export interface GetApprovalsResponseDataAttributesAchCounterparty {
-    /** External party being paid or debited (epty_*). */
+    /** External party being paid (epty_*). */
     externalPartyId: string;
     /** External party display or legal name. */
     name: string;
     /** External party type. */
     kind: Natural.GetApprovalsResponseDataAttributesAchCounterpartyKind;
-    /** Masked bank account the ACH debits or credits. */
+    /** Masked bank account the ACH payment uses. */
     account: Natural.GetApprovalsResponseDataAttributesAchCounterpartyAccount;
 }

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesAchCounterpartyAccount.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Masked bank account the ACH debits or credits.
+ * Masked bank account the ACH payment uses.
  */
 export interface GetApprovalsResponseDataAttributesAchCounterpartyAccount {
     /** External party account (epa_*). */

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesAchDirection.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesAchDirection.mjs CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesCheck.d.mts CHANGED Viewed

@@ -9,4 +9,6 @@ export interface GetApprovalsResponseDataAttributesCheck {
     amount: number;
     /** Memo printed on the check. */
     memo: string;
+    /** Description for the sender's internal reference, or null. Never printed on the check or shared with the counterparty. */
+    internalDescription: string | null;
 }

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesRealtime.d.mts CHANGED Viewed

@@ -2,6 +2,8 @@ import type * as Natural from "../../../index.mjs";
 export interface GetApprovalsResponseDataAttributesRealtime {
     /** Description supplied when the payment was created. */
     description: string;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.GetApprovalsResponseDataAttributesRealtimeCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/GetApprovalsResponseDataAttributesWire.d.mts CHANGED Viewed

@@ -4,6 +4,8 @@ export interface GetApprovalsResponseDataAttributesWire {
     description: string;
     /** Remittance information, or null. */
     remittanceInfo: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.GetApprovalsResponseDataAttributesWireCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAch.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 export interface ListApprovalsResponseDataItemAttributesAch {
-    /** `debit` pulls funds from the counterparty account; `credit` pushes funds to it. */
+    /** Direction of the payment. */
     direction: Natural.ListApprovalsResponseDataItemAttributesAchDirection;
     /** ACH SEC code the entry is submitted under. */
     secCode: Natural.ListApprovalsResponseDataItemAttributesAchSecCode;
@@ -8,6 +8,8 @@ export interface ListApprovalsResponseDataItemAttributesAch {
     companyEntryDescription: string;
     /** Payment-related information submitted as the NACHA addenda record, or null. */
     addenda: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchCounterparty.d.mts CHANGED Viewed

@@ -1,11 +1,11 @@
 import type * as Natural from "../../../index.mjs";
 export interface ListApprovalsResponseDataItemAttributesAchCounterparty {
-    /** External party being paid or debited (epty_*). */
+    /** External party being paid (epty_*). */
     externalPartyId: string;
     /** External party display or legal name. */
     name: string;
     /** External party type. */
     kind: Natural.ListApprovalsResponseDataItemAttributesAchCounterpartyKind;
-    /** Masked bank account the ACH debits or credits. */
+    /** Masked bank account the ACH payment uses. */
     account: Natural.ListApprovalsResponseDataItemAttributesAchCounterpartyAccount;
 }

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchCounterpartyAccount.d.mts CHANGED Viewed

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.mjs";
 /**
- * Masked bank account the ACH debits or credits.
+ * Masked bank account the ACH payment uses.
  */
 export interface ListApprovalsResponseDataItemAttributesAchCounterpartyAccount {
     /** External party account (epa_*). */

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchDirection.d.mts CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchDirection.mjs CHANGED Viewed

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

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesCheck.d.mts CHANGED Viewed

@@ -9,4 +9,6 @@ export interface ListApprovalsResponseDataItemAttributesCheck {
     amount: number;
     /** Memo printed on the check. */
     memo: string;
+    /** Description for the sender's internal reference, or null. Never printed on the check or shared with the counterparty. */
+    internalDescription: string | null;
 }

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesRealtime.d.mts CHANGED Viewed

@@ -2,6 +2,8 @@ import type * as Natural from "../../../index.mjs";
 export interface ListApprovalsResponseDataItemAttributesRealtime {
     /** Description supplied when the payment was created. */
     description: string;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.ListApprovalsResponseDataItemAttributesRealtimeCounterparty | null;
 }

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWire.d.mts CHANGED Viewed

@@ -4,6 +4,8 @@ export interface ListApprovalsResponseDataItemAttributesWire {
     description: string;
     /** Remittance information, or null. */
     remittanceInfo: string | null;
+    /** Description for the sender's internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Destination party and masked account, or null when it can no longer be resolved. */
     counterparty: Natural.ListApprovalsResponseDataItemAttributesWireCounterparty | null;
 }

package/dist/esm/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesClaim.d.mts ADDED Viewed

@@ -0,0 +1,8 @@
+export interface FulfillPaymentRequestsResponseDataAttributesClaim {
+    /** RFC 3339 timestamp when the recipient began claiming this payment, or null while unclaimed or unobserved. */
+    startedAt: string | null;
+    /** RFC 3339 timestamp when the recipient claimed this payment, or null while unclaimed. */
+    claimedAt: string | null;
+    /** RFC 3339 timestamp when a claimed payment detached from its recipient, or null. */
+    unboundAt: string | null;
+}

package/dist/esm/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesClaim.mjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ // This file was auto-generated by Fern from our API Definition.
2	+ export {};

package/dist/esm/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesFailure.d.mts ADDED Viewed

@@ -0,0 +1,6 @@
+export interface FulfillPaymentRequestsResponseDataAttributesFailure {
+    /** Reason code, when available. */
+    code: string | null;
+    /** Reason text, when available. */
+    reason: string | null;
+}

package/dist/esm/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesFailure.mjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ // This file was auto-generated by Fern from our API Definition.
2	+ export {};

package/dist/esm/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesReturn.d.mts ADDED Viewed

@@ -0,0 +1,6 @@
+export interface FulfillPaymentRequestsResponseDataAttributesReturn {
+    /** Reason code, when available. */
+    code: string | null;
+    /** Reason text, when available. */
+    reason: string | null;
+}