@naturalpay/sdk 1.6.19 → 1.6.21

package/dist/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesCheck.d.ts

@@ -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/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesRealtime.d.ts

@@ -2,6 +2,8 @@ import type * as Natural from "../../../index.js";
 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/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesWire.d.ts

@@ -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/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAch.d.ts

@@ -1,6 +1,6 @@
 import type * as Natural from "../../../index.js";
 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/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchCounterparty.d.ts

@@ -1,11 +1,11 @@
 import type * as Natural from "../../../index.js";
 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/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchCounterpartyAccount.d.ts

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

package/dist/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchDirection.d.ts

@@ -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/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAchDirection.js

@@ -2,7 +2,7 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListApprovalsResponseDataItemAttributesAchDirection = void 0;
-/** `debit` pulls funds from the counterparty account; `credit` pushes funds to it. */
+/** Direction of the payment. */
 exports.ListApprovalsResponseDataItemAttributesAchDirection = {
     Debit: "debit",
     Credit: "credit",

package/dist/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesCheck.d.ts

@@ -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/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesRealtime.d.ts

@@ -2,6 +2,8 @@ import type * as Natural from "../../../index.js";
 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/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWire.d.ts

@@ -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/cjs/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesClaim.d.ts

@@ -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/cjs/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesClaim.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesFailure.d.ts

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

package/dist/cjs/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesFailure.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesReturn.d.ts

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

package/dist/cjs/api/resources/paymentRequests/types/FulfillPaymentRequestsResponseDataAttributesReturn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/paymentRequests/types/FulfilledReqAttrs.d.ts

@@ -12,6 +12,16 @@ export interface FulfilledReqAttrs {
     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.FulfillPaymentRequestsResponseDataAttributesFee | null;
+    /** RFC 3339 timestamp when this payment was submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.FulfillPaymentRequestsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.FulfillPaymentRequestsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.FulfillPaymentRequestsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/cjs/api/resources/paymentRequests/types/index.d.ts

@@ -86,10 +86,13 @@ export * from "./FulfilledReqTxnRel.js";
 export * from "./FulfillPaymentRequestsRequestPaymentSource.js";
 export * from "./FulfillPaymentRequestsRequestPaymentSourceExternalAccount.js";
 export * from "./FulfillPaymentRequestsRequestPaymentSourceWallet.js";
+export * from "./FulfillPaymentRequestsResponseDataAttributesClaim.js";
+export * from "./FulfillPaymentRequestsResponseDataAttributesFailure.js";
 export * from "./FulfillPaymentRequestsResponseDataAttributesFee.js";
 export * from "./FulfillPaymentRequestsResponseDataAttributesFeeApplied.js";
 export * from "./FulfillPaymentRequestsResponseDataAttributesFeeCurrency.js";
 export * from "./FulfillPaymentRequestsResponseDataAttributesFeePayer.js";
+export * from "./FulfillPaymentRequestsResponseDataAttributesReturn.js";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestData.js";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestDataType.js";
 export * from "./FulfillPaymentRequestsResponseDataRelationshipsRecipientAgent.js";

package/dist/cjs/api/resources/paymentRequests/types/index.js

@@ -102,10 +102,13 @@ __exportStar(require("./FulfilledReqTxnRel.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsRequestPaymentSource.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsRequestPaymentSourceExternalAccount.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsRequestPaymentSourceWallet.js"), exports);
+__exportStar(require("./FulfillPaymentRequestsResponseDataAttributesClaim.js"), exports);
+__exportStar(require("./FulfillPaymentRequestsResponseDataAttributesFailure.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataAttributesFee.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataAttributesFeeApplied.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataAttributesFeeCurrency.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataAttributesFeePayer.js"), exports);
+__exportStar(require("./FulfillPaymentRequestsResponseDataAttributesReturn.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestData.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataRelationshipsPaymentRequestDataType.js"), exports);
 __exportStar(require("./FulfillPaymentRequestsResponseDataRelationshipsRecipientAgent.js"), exports);

package/dist/cjs/api/resources/payments/types/CancelPaymentsResponseDataAttributesClaim.d.ts

@@ -0,0 +1,8 @@
+export interface CancelPaymentsResponseDataAttributesClaim {
+    /** 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/cjs/api/resources/payments/types/CancelPaymentsResponseDataAttributesClaim.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/CancelPaymentsResponseDataAttributesFailure.d.ts

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

package/dist/cjs/api/resources/payments/types/CancelPaymentsResponseDataAttributesFailure.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/CancelPaymentsResponseDataAttributesReturn.d.ts

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

package/dist/cjs/api/resources/payments/types/CancelPaymentsResponseDataAttributesReturn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/CancelledPmtAttrs.d.ts

@@ -12,6 +12,16 @@ export interface CancelledPmtAttrs {
     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 submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.CancelPaymentsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.CancelPaymentsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.CancelPaymentsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/cjs/api/resources/payments/types/CreatePaymentsResponseDataAttributesClaim.d.ts

@@ -0,0 +1,8 @@
+export interface CreatePaymentsResponseDataAttributesClaim {
+    /** 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/cjs/api/resources/payments/types/CreatePaymentsResponseDataAttributesClaim.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/CreatePaymentsResponseDataAttributesFailure.d.ts

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

package/dist/cjs/api/resources/payments/types/CreatePaymentsResponseDataAttributesFailure.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/CreatePaymentsResponseDataAttributesReturn.d.ts

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

package/dist/cjs/api/resources/payments/types/CreatePaymentsResponseDataAttributesReturn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/GetPaymentsResponseDataAttributesClaim.d.ts

@@ -0,0 +1,8 @@
+export interface GetPaymentsResponseDataAttributesClaim {
+    /** 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/cjs/api/resources/payments/types/GetPaymentsResponseDataAttributesClaim.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/GetPaymentsResponseDataAttributesFailure.d.ts

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

package/dist/cjs/api/resources/payments/types/GetPaymentsResponseDataAttributesFailure.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/GetPaymentsResponseDataAttributesReturn.d.ts

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

package/dist/cjs/api/resources/payments/types/GetPaymentsResponseDataAttributesReturn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/ListPaymentsResponseDataItemAttributesClaim.d.ts

@@ -0,0 +1,8 @@
+export interface ListPaymentsResponseDataItemAttributesClaim {
+    /** 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/cjs/api/resources/payments/types/ListPaymentsResponseDataItemAttributesClaim.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFailure.d.ts

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

package/dist/cjs/api/resources/payments/types/ListPaymentsResponseDataItemAttributesFailure.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/ListPaymentsResponseDataItemAttributesReturn.d.ts

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

package/dist/cjs/api/resources/payments/types/ListPaymentsResponseDataItemAttributesReturn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/payments/types/NewPaymentAttrs.d.ts

@@ -12,6 +12,16 @@ export interface NewPaymentAttrs {
     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 submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.CreatePaymentsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.CreatePaymentsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.CreatePaymentsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/cjs/api/resources/payments/types/PaymentAttrs.d.ts

@@ -12,6 +12,16 @@ export interface PaymentAttrs {
     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 submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.ListPaymentsResponseDataItemAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.ListPaymentsResponseDataItemAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.ListPaymentsResponseDataItemAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/cjs/api/resources/payments/types/PaymentDetailAttrs.d.ts

@@ -12,6 +12,16 @@ export interface PaymentDetailAttrs {
     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 submitted to money movement, or null while unsubmitted. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when this payment reached a terminal status, or null while in flight. */
+    terminalAt: string | null;
+    /** Failure details when this payment failed. */
+    failure: Natural.GetPaymentsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.GetPaymentsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.GetPaymentsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/cjs/api/resources/payments/types/index.d.ts

@@ -9,10 +9,13 @@ export * from "./CancelledPmtSenderRefKind.js";
 export * from "./CancelledPmtSenderRel.js";
 export * from "./CancelledPmtStatus.js";
 export * from "./CancelledPmtTxnRel.js";
+export * from "./CancelPaymentsResponseDataAttributesClaim.js";
+export * from "./CancelPaymentsResponseDataAttributesFailure.js";
 export * from "./CancelPaymentsResponseDataAttributesFee.js";
 export * from "./CancelPaymentsResponseDataAttributesFeeApplied.js";
 export * from "./CancelPaymentsResponseDataAttributesFeeCurrency.js";
 export * from "./CancelPaymentsResponseDataAttributesFeePayer.js";
+export * from "./CancelPaymentsResponseDataAttributesReturn.js";
 export * from "./CancelPaymentsResponseDataRelationshipsPaymentRequestData.js";
 export * from "./CancelPaymentsResponseDataRelationshipsPaymentRequestDataType.js";
 export * from "./CancelPaymentsResponseDataRelationshipsRecipientAgent.js";
@@ -33,10 +36,13 @@ export * from "./CreatePaymentsRequestCounterpartyHandle.js";
 export * from "./CreatePaymentsRequestCounterpartyPartyId.js";
 export * from "./CreatePaymentsRequestCounterpartyPhone.js";
 export * from "./CreatePaymentsRequestDisableNotificationsItem.js";
+export * from "./CreatePaymentsResponseDataAttributesClaim.js";
+export * from "./CreatePaymentsResponseDataAttributesFailure.js";
 export * from "./CreatePaymentsResponseDataAttributesFee.js";
 export * from "./CreatePaymentsResponseDataAttributesFeeApplied.js";
 export * from "./CreatePaymentsResponseDataAttributesFeeCurrency.js";
 export * from "./CreatePaymentsResponseDataAttributesFeePayer.js";
+export * from "./CreatePaymentsResponseDataAttributesReturn.js";
 export * from "./CreatePaymentsResponseDataRelationshipsPaymentRequestData.js";
 export * from "./CreatePaymentsResponseDataRelationshipsPaymentRequestDataType.js";
 export * from "./CreatePaymentsResponseDataRelationshipsRecipientAgent.js";
@@ -50,10 +56,13 @@ export * from "./CreatePaymentsResponseDataRelationshipsSenderAgentDataType.js";
 export * from "./CreatePaymentsResponseDataRelationshipsSenderData.js";
 export * from "./CreatePaymentsResponseDataRelationshipsTransactionData.js";
 export * from "./CreatePaymentsResponseDataRelationshipsTransactionDataType.js";
+export * from "./GetPaymentsResponseDataAttributesClaim.js";
+export * from "./GetPaymentsResponseDataAttributesFailure.js";
 export * from "./GetPaymentsResponseDataAttributesFee.js";
 export * from "./GetPaymentsResponseDataAttributesFeeApplied.js";
 export * from "./GetPaymentsResponseDataAttributesFeeCurrency.js";
 export * from "./GetPaymentsResponseDataAttributesFeePayer.js";
+export * from "./GetPaymentsResponseDataAttributesReturn.js";
 export * from "./GetPaymentsResponseDataRelationshipsPaymentRequestData.js";
 export * from "./GetPaymentsResponseDataRelationshipsPaymentRequestDataType.js";
 export * from "./GetPaymentsResponseDataRelationshipsRecipientAgent.js";
@@ -68,10 +77,13 @@ export * from "./GetPaymentsResponseDataRelationshipsSenderData.js";
 export * from "./GetPaymentsResponseDataRelationshipsTransactionData.js";
 export * from "./GetPaymentsResponseDataRelationshipsTransactionDataType.js";
 export * from "./ListPaymentsResponseDataItem.js";
+export * from "./ListPaymentsResponseDataItemAttributesClaim.js";
+export * from "./ListPaymentsResponseDataItemAttributesFailure.js";
 export * from "./ListPaymentsResponseDataItemAttributesFee.js";
 export * from "./ListPaymentsResponseDataItemAttributesFeeApplied.js";
 export * from "./ListPaymentsResponseDataItemAttributesFeeCurrency.js";
 export * from "./ListPaymentsResponseDataItemAttributesFeePayer.js";
+export * from "./ListPaymentsResponseDataItemAttributesReturn.js";
 export * from "./ListPaymentsResponseDataItemRelationshipsPaymentRequestData.js";
 export * from "./ListPaymentsResponseDataItemRelationshipsPaymentRequestDataType.js";
 export * from "./ListPaymentsResponseDataItemRelationshipsRecipientAgent.js";

package/dist/cjs/api/resources/payments/types/index.js

@@ -25,10 +25,13 @@ __exportStar(require("./CancelledPmtSenderRefKind.js"), exports);
 __exportStar(require("./CancelledPmtSenderRel.js"), exports);
 __exportStar(require("./CancelledPmtStatus.js"), exports);
 __exportStar(require("./CancelledPmtTxnRel.js"), exports);
+__exportStar(require("./CancelPaymentsResponseDataAttributesClaim.js"), exports);
+__exportStar(require("./CancelPaymentsResponseDataAttributesFailure.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataAttributesFee.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataAttributesFeeApplied.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataAttributesFeeCurrency.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataAttributesFeePayer.js"), exports);
+__exportStar(require("./CancelPaymentsResponseDataAttributesReturn.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataRelationshipsPaymentRequestData.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataRelationshipsPaymentRequestDataType.js"), exports);
 __exportStar(require("./CancelPaymentsResponseDataRelationshipsRecipientAgent.js"), exports);
@@ -49,10 +52,13 @@ __exportStar(require("./CreatePaymentsRequestCounterpartyHandle.js"), exports);
 __exportStar(require("./CreatePaymentsRequestCounterpartyPartyId.js"), exports);
 __exportStar(require("./CreatePaymentsRequestCounterpartyPhone.js"), exports);
 __exportStar(require("./CreatePaymentsRequestDisableNotificationsItem.js"), exports);
+__exportStar(require("./CreatePaymentsResponseDataAttributesClaim.js"), exports);
+__exportStar(require("./CreatePaymentsResponseDataAttributesFailure.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataAttributesFee.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataAttributesFeeApplied.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataAttributesFeeCurrency.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataAttributesFeePayer.js"), exports);
+__exportStar(require("./CreatePaymentsResponseDataAttributesReturn.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataRelationshipsPaymentRequestData.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataRelationshipsPaymentRequestDataType.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataRelationshipsRecipientAgent.js"), exports);
@@ -66,10 +72,13 @@ __exportStar(require("./CreatePaymentsResponseDataRelationshipsSenderAgentDataTy
 __exportStar(require("./CreatePaymentsResponseDataRelationshipsSenderData.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataRelationshipsTransactionData.js"), exports);
 __exportStar(require("./CreatePaymentsResponseDataRelationshipsTransactionDataType.js"), exports);
+__exportStar(require("./GetPaymentsResponseDataAttributesClaim.js"), exports);
+__exportStar(require("./GetPaymentsResponseDataAttributesFailure.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataAttributesFee.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataAttributesFeeApplied.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataAttributesFeeCurrency.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataAttributesFeePayer.js"), exports);
+__exportStar(require("./GetPaymentsResponseDataAttributesReturn.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataRelationshipsPaymentRequestData.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataRelationshipsPaymentRequestDataType.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataRelationshipsRecipientAgent.js"), exports);
@@ -84,10 +93,13 @@ __exportStar(require("./GetPaymentsResponseDataRelationshipsSenderData.js"), exp
 __exportStar(require("./GetPaymentsResponseDataRelationshipsTransactionData.js"), exports);
 __exportStar(require("./GetPaymentsResponseDataRelationshipsTransactionDataType.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItem.js"), exports);
+__exportStar(require("./ListPaymentsResponseDataItemAttributesClaim.js"), exports);
+__exportStar(require("./ListPaymentsResponseDataItemAttributesFailure.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemAttributesFee.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemAttributesFeeApplied.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemAttributesFeeCurrency.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemAttributesFeePayer.js"), exports);
+__exportStar(require("./ListPaymentsResponseDataItemAttributesReturn.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemRelationshipsPaymentRequestData.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemRelationshipsPaymentRequestDataType.js"), exports);
 __exportStar(require("./ListPaymentsResponseDataItemRelationshipsRecipientAgent.js"), exports);

package/dist/cjs/api/resources/realtime/client/Client.d.ts

@@ -66,7 +66,8 @@ export declare class RealtimeClient {
      *         amount: 25000,
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-     *         description: "Invoice 1042 settlement"
+     *         description: "Invoice 1042 settlement",
+     *         internalDescription: "Vendor settlement, ledger 1042"
      *     })
      */
     create(request: Natural.CreateRealtimeRequest, requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<Natural.CreateRealtimeResponse>;

package/dist/cjs/api/resources/realtime/client/Client.js

@@ -208,7 +208,8 @@ class RealtimeClient {
      *         amount: 25000,
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-     *         description: "Invoice 1042 settlement"
+     *         description: "Invoice 1042 settlement",
+     *         internalDescription: "Vendor settlement, ledger 1042"
      *     })
      */
     create(request, requestOptions) {

package/dist/cjs/api/resources/realtime/client/requests/CreateRealtimeRequest.d.ts

@@ -6,7 +6,8 @@ import type * as Natural from "../../../../index.js";
  *         amount: 25000,
  *         currency: "USD",
  *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
- *         description: "Invoice 1042 settlement"
+ *         description: "Invoice 1042 settlement",
+ *         internalDescription: "Vendor settlement, ledger 1042"
  *     }
  */
 export interface CreateRealtimeRequest {
@@ -22,6 +23,8 @@ export interface CreateRealtimeRequest {
     walletId?: string;
     /** External party account (epa_*) to pay. */
     externalPartyAccountId: string;
-    /** Payment description delivered to the recipient bank. Maximum 140 characters from the ISO 20022 character set (letters, digits, spaces, and / - ? : ( ) . , ' +). */
+    /** Payment description delivered to the recipient bank with the payment. Maximum 140 characters from the ISO 20022 character set (letters, digits, spaces, and / - ? : ( ) . , ' +). */
     description: string;
+    /** Description for your internal reference. Never shared with the counterparty or the banking network. Maximum 255 characters. */
+    internalDescription?: string;
 }