@naturalpay/sdk 1.6.20 → 1.6.22

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

@@ -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/esm/api/resources/payments/types/ListPaymentsResponseDataItemAttributesClaim.mjs

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

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

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

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

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

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

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

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

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

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

@@ -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/esm/api/resources/payments/types/PaymentAttrs.d.mts

@@ -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/esm/api/resources/payments/types/PaymentDetailAttrs.d.mts

@@ -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/esm/api/resources/payments/types/index.d.mts

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

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

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

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

@@ -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/esm/api/resources/realtime/client/Client.mjs

@@ -172,7 +172,8 @@ export 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/esm/api/resources/realtime/client/requests/CreateRealtimeRequest.d.mts

@@ -6,7 +6,8 @@ import type * as Natural from "../../../../index.mjs";
  *         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;
 }

package/dist/esm/api/resources/realtime/types/CancelRealtimeResponseDataAttributes.d.mts

@@ -10,6 +10,8 @@ export interface CancelRealtimeResponseDataAttributes {
     status: Natural.CancelRealtimeResponseDataAttributesStatus;
     /** Payment description delivered to the recipient bank. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the payment failed, or null. */
     failure: Natural.CancelRealtimeResponseDataAttributesFailure | null;
     /** RFC 3339 timestamp when the payment was submitted to the network, or null. */

package/dist/esm/api/resources/realtime/types/CreateRealtimeResponseDataAttributes.d.mts

@@ -10,6 +10,8 @@ export interface CreateRealtimeResponseDataAttributes {
     status: Natural.CreateRealtimeResponseDataAttributesStatus;
     /** Payment description delivered to the recipient bank. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the payment failed, or null. */
     failure: Natural.CreateRealtimeResponseDataAttributesFailure | null;
     /** RFC 3339 timestamp when the payment was submitted to the network, or null. */

package/dist/esm/api/resources/realtime/types/GetRealtimeResponseDataAttributes.d.mts

@@ -10,6 +10,8 @@ export interface GetRealtimeResponseDataAttributes {
     status: Natural.GetRealtimeResponseDataAttributesStatus;
     /** Payment description delivered to the recipient bank. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the payment failed, or null. */
     failure: Natural.GetRealtimeResponseDataAttributesFailure | null;
     /** RFC 3339 timestamp when the payment was submitted to the network, or null. */

package/dist/esm/api/resources/realtime/types/ListRealtimeResponseDataItemAttributes.d.mts

@@ -10,6 +10,8 @@ export interface ListRealtimeResponseDataItemAttributes {
     status: Natural.ListRealtimeResponseDataItemAttributesStatus;
     /** Payment description delivered to the recipient bank. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the payment failed, or null. */
     failure: Natural.ListRealtimeResponseDataItemAttributesFailure | null;
     /** RFC 3339 timestamp when the payment was submitted to the network, or null. */

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributes.d.mts

@@ -12,6 +12,16 @@ export interface CompletePaymentClaimSimulationsResponseDataAttributes {
     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.CompletePaymentClaimSimulationsResponseDataAttributesFee | 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.CompletePaymentClaimSimulationsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.CompletePaymentClaimSimulationsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.CompletePaymentClaimSimulationsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesClaim.d.mts

@@ -0,0 +1,8 @@
+export interface CompletePaymentClaimSimulationsResponseDataAttributesClaim {
+    /** 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/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesClaim.mjs

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

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesFailure.d.mts

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

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesFailure.mjs

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

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesReturn.d.mts

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

package/dist/esm/api/resources/simulations/types/CompletePaymentClaimSimulationsResponseDataAttributesReturn.mjs

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

package/dist/esm/api/resources/simulations/types/DeclinePaymentRequestSimulationsResponseDataAttributes.d.mts

@@ -50,6 +50,8 @@ export interface DeclinePaymentRequestSimulationsResponseDataAttributes {
     paymentLinkUrl: string;
     /** Transaction (txn_*) created by the most recent payment attempt, or null when none has been made. */
     transactionId: string | null;
+    /** RFC 3339 timestamp when this payment request expires, or null when it does not expire. */
+    expiresAt: string | null;
     /** RFC 3339 timestamp when the payment request was created. */
     createdAt: string;
     /** RFC 3339 timestamp when the payment request was last updated. */

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributes.d.mts

@@ -12,6 +12,16 @@ export interface FulfillPaymentRequestSimulationsResponseDataAttributes {
     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.FulfillPaymentRequestSimulationsResponseDataAttributesFee | 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.FulfillPaymentRequestSimulationsResponseDataAttributesFailure | null;
+    /** Return details when this payment was returned. */
+    return: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesReturn | null;
+    /** Claim lifecycle for payments sent to an off-platform recipient, or null when this payment is not claim-based. */
+    claim: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesClaim | null;
     /** RFC 3339 timestamp when this payment was created. */
     createdAt: string;
     /** RFC 3339 timestamp when this payment was last updated, or null. */

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesClaim.d.mts

@@ -0,0 +1,8 @@
+export interface FulfillPaymentRequestSimulationsResponseDataAttributesClaim {
+    /** 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/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesClaim.mjs

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

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesFailure.d.mts

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

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesFailure.mjs

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

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesReturn.d.mts

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

package/dist/esm/api/resources/simulations/types/FulfillPaymentRequestSimulationsResponseDataAttributesReturn.mjs

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

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

@@ -16,10 +16,13 @@ export * from "./AcceptCustomerInvitationSimulationsResponseDataType.mjs";
 export * from "./CompletePaymentClaimSimulationsResponse.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseData.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributes.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesClaim.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFailure.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFee.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesReturn.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesStatus.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationships.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationshipsPaymentRequest.mjs";
@@ -106,10 +109,13 @@ export * from "./FailWireSimulationsResponseDataType.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponse.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseData.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributes.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesClaim.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFailure.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFee.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesReturn.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesStatus.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationships.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationshipsPaymentRequest.mjs";

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

@@ -16,10 +16,13 @@ export * from "./AcceptCustomerInvitationSimulationsResponseDataType.mjs";
 export * from "./CompletePaymentClaimSimulationsResponse.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseData.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributes.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesClaim.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFailure.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFee.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./CompletePaymentClaimSimulationsResponseDataAttributesReturn.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataAttributesStatus.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationships.mjs";
 export * from "./CompletePaymentClaimSimulationsResponseDataRelationshipsPaymentRequest.mjs";
@@ -106,10 +109,13 @@ export * from "./FailWireSimulationsResponseDataType.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponse.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseData.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributes.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesClaim.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFailure.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFee.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeApplied.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeeCurrency.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesFeePayer.mjs";
+export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesReturn.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributesStatus.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationships.mjs";
 export * from "./FulfillPaymentRequestSimulationsResponseDataRelationshipsPaymentRequest.mjs";

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

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

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

@@ -172,7 +172,8 @@ export class WireClient {
      *         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/esm/api/resources/wire/client/requests/CreateWireRequest.d.mts

@@ -6,7 +6,8 @@ import type * as Natural from "../../../../index.mjs";
  *         amount: 25000,
  *         currency: "USD",
  *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
- *         description: "Invoice 1042 settlement"
+ *         description: "Invoice 1042 settlement",
+ *         internalDescription: "Vendor settlement, ledger 1042"
  *     }
  */
 export interface CreateWireRequest {
@@ -22,8 +23,10 @@ export interface CreateWireRequest {
     walletId?: string;
     /** External party account (epa_*) to pay. */
     externalPartyAccountId: string;
-    /** Internal payment description. Maximum 1000 characters. */
+    /** Payment description stored for the sender's records. Not sent over Fedwire. Maximum 1000 characters. */
     description: string;
-    /** Remittance information for the beneficiary. Maximum 105 characters: letters, digits, spaces, and / - ? : ( ) . , ' +. */
+    /** Remittance information delivered to the beneficiary, combined with the originator name into the Fedwire OBI field. Maximum 105 characters: letters, digits, spaces, and / - ? : ( ) . , ' +. */
     remittanceInfo?: string;
+    /** Description for your internal reference. Never shared with the counterparty or the banking network. Maximum 255 characters. */
+    internalDescription?: string;
 }

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributes.d.mts

@@ -4,12 +4,16 @@ export interface CancelWireResponseDataAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.CancelWireResponseDataAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the wire ended before network submission, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CancelWireResponseDataAttributesFee | null;
     /** Wire status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, REJECTED, FAILED, or CANCELED end it. */
     status: Natural.CancelWireResponseDataAttributesStatus;
-    /** Remittance information sent to the beneficiary, or null. */
+    /** Remittance information delivered to the beneficiary, or null. */
     remittanceInfo: string | null;
-    /** Internal payment description. */
+    /** Payment description stored for the sender's records. Not sent over Fedwire. */
     description: string;
+    /** Description for your internal reference, or null. Never shared with the counterparty or the banking network. */
+    internalDescription: string | null;
     /** Failure details when the wire failed, or null. */
     failure: Natural.CancelWireResponseDataAttributesFailure | null;
     /** RFC 3339 timestamp when the wire was submitted, or null. */

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFee.d.mts

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFee.mjs

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeApplied.d.mts

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeApplied.mjs

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeCurrency.d.mts

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeeCurrency.mjs

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeePayer.d.mts

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

package/dist/esm/api/resources/wire/types/CancelWireResponseDataAttributesFeePayer.mjs

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