@naturalpay/sdk 1.6.19 → 1.6.21

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -4,10 +4,14 @@ export interface CancelRealtimeResponseDataAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.CancelRealtimeResponseDataAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the payment failed, was denied, or was canceled, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CancelRealtimeResponseDataAttributesFee | null;
     /** Realtime payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, or CANCELED end it. */
     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/CancelRealtimeResponseDataAttributesFee.d.mts

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

package/dist/esm/api/resources/realtime/types/CancelRealtimeResponseDataAttributesFee.mjs

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

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

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

package/dist/esm/api/resources/realtime/types/CancelRealtimeResponseDataAttributesFeeApplied.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 CancelRealtimeResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

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

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

package/dist/esm/api/resources/realtime/types/CancelRealtimeResponseDataAttributesFeeCurrency.mjs

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

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

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

package/dist/esm/api/resources/realtime/types/CancelRealtimeResponseDataAttributesFeePayer.mjs

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

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

@@ -4,10 +4,14 @@ export interface CreateRealtimeResponseDataAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.CreateRealtimeResponseDataAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the payment failed, was denied, or was canceled, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.CreateRealtimeResponseDataAttributesFee | null;
     /** Realtime payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, or CANCELED end it. */
     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/CreateRealtimeResponseDataAttributesFee.d.mts

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

package/dist/esm/api/resources/realtime/types/CreateRealtimeResponseDataAttributesFee.mjs

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

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

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

package/dist/esm/api/resources/realtime/types/CreateRealtimeResponseDataAttributesFeeApplied.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 CreateRealtimeResponseDataAttributesFeeApplied = {
+    OnTop: "on_top",
+};

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

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

package/dist/esm/api/resources/realtime/types/CreateRealtimeResponseDataAttributesFeeCurrency.mjs

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

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

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

package/dist/esm/api/resources/realtime/types/CreateRealtimeResponseDataAttributesFeePayer.mjs

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

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

@@ -4,10 +4,14 @@ export interface GetRealtimeResponseDataAttributes {
     amount: number;
     /** Currency code. */
     currency: Natural.GetRealtimeResponseDataAttributesCurrency;
+    /** Fee added to your cost as the sender. Null when no fee applies, the payment failed, was denied, or was canceled, the fee was voided, or your party is not the fee payer. */
+    fee: Natural.GetRealtimeResponseDataAttributesFee | null;
     /** Realtime payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, or CANCELED end it. */
     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. */