@naturalpay/sdk 1.2.2 → 1.2.4

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

@@ -164,7 +164,10 @@ export class InvitationLinksClient {
      *                     perTransaction: 50000
      *                 }
      *             }],
-     *         name: "Carrier Payment Integration"
+     *         name: "Carrier Payment Integration",
+     *         tags: {
+     *             "integration": "carrier_payments"
+     *         }
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/invitationLinks/client/requests/CreateInvitationLinksRequest.d.mts

@@ -9,7 +9,10 @@ import type * as Natural from "../../../../index.mjs";
  *                     perTransaction: 50000
  *                 }
  *             }],
- *         name: "Carrier Payment Integration"
+ *         name: "Carrier Payment Integration",
+ *         tags: {
+ *             "integration": "carrier_payments"
+ *         }
  *     }
  */
 export interface CreateInvitationLinksRequest {
@@ -19,4 +22,5 @@ export interface CreateInvitationLinksRequest {
     expiresAt?: Date;
     /** Label for this link */
     name: string;
+    tags?: Record<string, string>;
 }

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts

@@ -3,11 +3,16 @@ export declare const CreateInvitationLinksRequestProposedAgentsItemPermissionsIt
     readonly PaymentsCreate: "payments.create";
     readonly ExternalPartiesRead: "external_parties.read";
     readonly ExternalPartiesCreate: "external_parties.create";
-    readonly DirectPaymentsRead: "direct_payments.read";
-    readonly DirectPaymentsCreate: "direct_payments.create";
+    readonly DirectRead: "direct.read";
+    readonly DirectCreate: "direct.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
+    readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
+    readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
+    readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
 };

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs

@@ -4,11 +4,16 @@ export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = {
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
     ExternalPartiesCreate: "external_parties.create",
-    DirectPaymentsRead: "direct_payments.read",
-    DirectPaymentsCreate: "direct_payments.create",
+    DirectRead: "direct.read",
+    DirectCreate: "direct.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
+    WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
+    WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
+    WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
 };

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributes.d.mts

@@ -13,6 +13,8 @@ export interface CreateInvitationLinksResponseDataAttributes {
     name: string;
     /** When this link expires */
     expiresAt: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Plaintext link token. Returned only when the link is created; list and get return a masked form */
     token: string;
     /** Full shareable URL for this link. Returned only when the link is created */

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -3,11 +3,16 @@ export declare const CreateInvitationLinksResponseDataAttributesProposedAgentsIt
     readonly PaymentsCreate: "payments.create";
     readonly ExternalPartiesRead: "external_parties.read";
     readonly ExternalPartiesCreate: "external_parties.create";
-    readonly DirectPaymentsRead: "direct_payments.read";
-    readonly DirectPaymentsCreate: "direct_payments.create";
+    readonly DirectRead: "direct.read";
+    readonly DirectCreate: "direct.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
+    readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
+    readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
+    readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
 };

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -4,11 +4,16 @@ export const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermis
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
     ExternalPartiesCreate: "external_parties.create",
-    DirectPaymentsRead: "direct_payments.read",
-    DirectPaymentsCreate: "direct_payments.create",
+    DirectRead: "direct.read",
+    DirectCreate: "direct.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
+    WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
+    WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
+    WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
 };

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributes.d.mts

@@ -13,6 +13,8 @@ export interface GetInvitationLinksResponseDataAttributes {
     name: string;
     /** When this link expires */
     expiresAt: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Link token with all but the last 4 characters masked (for example ***bc4d). The full token and URL are returned only when the link is created */
     maskedToken: string;
 }

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -3,11 +3,16 @@ export declare const GetInvitationLinksResponseDataAttributesProposedAgentsItemP
     readonly PaymentsCreate: "payments.create";
     readonly ExternalPartiesRead: "external_parties.read";
     readonly ExternalPartiesCreate: "external_parties.create";
-    readonly DirectPaymentsRead: "direct_payments.read";
-    readonly DirectPaymentsCreate: "direct_payments.create";
+    readonly DirectRead: "direct.read";
+    readonly DirectCreate: "direct.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
+    readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
+    readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
+    readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
 };

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -4,11 +4,16 @@ export const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissio
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
     ExternalPartiesCreate: "external_parties.create",
-    DirectPaymentsRead: "direct_payments.read",
-    DirectPaymentsCreate: "direct_payments.create",
+    DirectRead: "direct.read",
+    DirectCreate: "direct.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
+    WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
+    WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
+    WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
 };

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributes.d.mts

@@ -13,6 +13,8 @@ export interface ListInvitationLinksResponseDataItemAttributes {
     name: string;
     /** When this link expires */
     expiresAt: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Link token with all but the last 4 characters masked (for example ***bc4d). The full token and URL are returned only when the link is created */
     maskedToken: string;
 }

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -3,11 +3,16 @@ export declare const ListInvitationLinksResponseDataItemAttributesProposedAgents
     readonly PaymentsCreate: "payments.create";
     readonly ExternalPartiesRead: "external_parties.read";
     readonly ExternalPartiesCreate: "external_parties.create";
-    readonly DirectPaymentsRead: "direct_payments.read";
-    readonly DirectPaymentsCreate: "direct_payments.create";
+    readonly DirectRead: "direct.read";
+    readonly DirectCreate: "direct.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
+    readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
+    readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
+    readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
 };

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.mjs

@@ -4,11 +4,16 @@ export const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPerm
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
     ExternalPartiesCreate: "external_parties.create",
-    DirectPaymentsRead: "direct_payments.read",
-    DirectPaymentsCreate: "direct_payments.create",
+    DirectRead: "direct.read",
+    DirectCreate: "direct.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
+    WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
+    WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
+    WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
 };

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributes.d.mts

@@ -13,6 +13,8 @@ export interface RevokeInvitationLinksResponseDataAttributes {
     name: string;
     /** When this link expires */
     expiresAt: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Link token with all but the last 4 characters masked (for example ***bc4d). The full token and URL are returned only when the link is created */
     maskedToken: string;
 }

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -3,11 +3,16 @@ export declare const RevokeInvitationLinksResponseDataAttributesProposedAgentsIt
     readonly PaymentsCreate: "payments.create";
     readonly ExternalPartiesRead: "external_parties.read";
     readonly ExternalPartiesCreate: "external_parties.create";
-    readonly DirectPaymentsRead: "direct_payments.read";
-    readonly DirectPaymentsCreate: "direct_payments.create";
+    readonly DirectRead: "direct.read";
+    readonly DirectCreate: "direct.create";
     readonly ExternalAccountsCreate: "external_accounts.create";
     readonly WalletsRead: "wallets.read";
+    readonly WalletsCreate: "wallets.create";
     readonly WalletsUpdate: "wallets.update";
+    readonly WalletsFund: "wallets.fund";
+    readonly WalletsDeposit: "wallets.deposit";
+    readonly WalletsTransfer: "wallets.transfer";
+    readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
 };

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -4,11 +4,16 @@ export const RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermis
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
     ExternalPartiesCreate: "external_parties.create",
-    DirectPaymentsRead: "direct_payments.read",
-    DirectPaymentsCreate: "direct_payments.create",
+    DirectRead: "direct.read",
+    DirectCreate: "direct.create",
     ExternalAccountsCreate: "external_accounts.create",
     WalletsRead: "wallets.read",
+    WalletsCreate: "wallets.create",
     WalletsUpdate: "wallets.update",
+    WalletsFund: "wallets.fund",
+    WalletsDeposit: "wallets.deposit",
+    WalletsTransfer: "wallets.transfer",
+    WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
 };

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

@@ -68,7 +68,10 @@ export declare class InvitationsClient {
      *             }, {
      *                 email: "cfo@velocitylogistics.com",
      *                 role: "ADMIN"
-     *             }]
+     *             }],
+     *         tags: {
+     *             "team": "operations"
+     *         }
      *     })
      */
     create(request: Natural.CreateInvitationsRequest, requestOptions?: InvitationsClient.RequestOptions): core.HttpResponsePromise<Natural.CreateInvitationsResponse>;

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

@@ -163,7 +163,10 @@ export class InvitationsClient {
      *             }, {
      *                 email: "cfo@velocitylogistics.com",
      *                 role: "ADMIN"
-     *             }]
+     *             }],
+     *         tags: {
+     *             "team": "operations"
+     *         }
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/invitations/client/requests/CreateInvitationsRequest.d.mts

@@ -8,10 +8,15 @@ import type * as Natural from "../../../../index.mjs";
  *             }, {
  *                 email: "cfo@velocitylogistics.com",
  *                 role: "ADMIN"
- *             }]
+ *             }],
+ *         tags: {
+ *             "team": "operations"
+ *         }
  *     }
  */
 export interface CreateInvitationsRequest {
     /** List of invitations to create (max 100). */
     invitations: Natural.CreateInvitationsRequestInvitationsItem[];
+    /** Tags applied to each invitation. */
+    tags?: Record<string, string>;
 }

package/dist/esm/api/resources/invitations/types/CreateInvitationsResponseDataItemAttributes.d.mts

@@ -6,6 +6,8 @@ export interface CreateInvitationsResponseDataItemAttributes {
     role: Natural.CreateInvitationsResponseDataItemAttributesRole;
     /** Invitation status. */
     status: Natural.CreateInvitationsResponseDataItemAttributesStatus;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this invitation expires. */
     expiresAt: string;
     /** When this invitation was created. */

package/dist/esm/api/resources/invitations/types/ListInvitationsResponseDataItemAttributes.d.mts

@@ -6,6 +6,8 @@ export interface ListInvitationsResponseDataItemAttributes {
     role: Natural.ListInvitationsResponseDataItemAttributesRole;
     /** Invitation status. */
     status: Natural.ListInvitationsResponseDataItemAttributesStatus;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this invitation expires. */
     expiresAt: string;
     /** When this invitation was created. */

package/dist/esm/api/resources/invitations/types/RevokeInvitationsResponseDataAttributes.d.mts

@@ -6,6 +6,8 @@ export interface RevokeInvitationsResponseDataAttributes {
     role: Natural.RevokeInvitationsResponseDataAttributesRole;
     /** Invitation status. */
     status: Natural.RevokeInvitationsResponseDataAttributesStatus;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this invitation expires. */
     expiresAt: string;
     /** When this invitation was created. */

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

@@ -65,6 +65,9 @@ export declare class PaymentRequestsClient {
      *         amount: 2500,
      *         currency: "USD",
      *         description: "Invoice 7",
+     *         tags: {
+     *             "invoice_id": "inv_7"
+     *         },
      *         payerName: "Ada Lovelace",
      *         payer: {
      *             type: "email",
@@ -155,6 +158,9 @@ export declare class PaymentRequestsClient {
      *         paymentSource: {
      *             type: "wallet",
      *             walletId: "wal_550e8400e29b41d4a716446655440000"
+     *         },
+     *         tags: {
+     *             "invoice_id": "inv_7"
      *         }
      *     })
      */

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

@@ -201,6 +201,9 @@ export class PaymentRequestsClient {
      *         amount: 2500,
      *         currency: "USD",
      *         description: "Invoice 7",
+     *         tags: {
+     *             "invoice_id": "inv_7"
+     *         },
      *         payerName: "Ada Lovelace",
      *         payer: {
      *             type: "email",
@@ -536,6 +539,9 @@ export class PaymentRequestsClient {
      *         paymentSource: {
      *             type: "wallet",
      *             walletId: "wal_550e8400e29b41d4a716446655440000"
+     *         },
+     *         tags: {
+     *             "invoice_id": "inv_7"
      *         }
      *     })
      */

package/dist/esm/api/resources/paymentRequests/client/requests/NewFulfilledReqParams.d.mts

@@ -7,6 +7,9 @@ import type * as Natural from "../../../../index.mjs";
  *         paymentSource: {
  *             type: "wallet",
  *             walletId: "wal_550e8400e29b41d4a716446655440000"
+ *         },
+ *         tags: {
+ *             "invoice_id": "inv_7"
  *         }
  *     }
  */
@@ -16,4 +19,5 @@ export interface NewFulfilledReqParams {
     idempotencyKey: string;
     /** Source of funds for the payment. */
     paymentSource: Natural.FulfillPaymentRequestsRequestPaymentSource;
+    tags?: Record<string, string>;
 }

package/dist/esm/api/resources/paymentRequests/client/requests/NewPayReqParams.d.mts

@@ -6,6 +6,9 @@ import type * as Natural from "../../../../index.mjs";
  *         amount: 2500,
  *         currency: "USD",
  *         description: "Invoice 7",
+ *         tags: {
+ *             "invoice_id": "inv_7"
+ *         },
  *         payerName: "Ada Lovelace",
  *         payer: {
  *             type: "email",
@@ -26,6 +29,7 @@ export interface NewPayReqParams {
     currency?: Natural.NewPayReqCurrency;
     /** Free-form description shown to the payer. Maximum 80 characters. */
     description?: string;
+    tags?: Record<string, string>;
     /** Display name of the payer. Maximum 32 characters. */
     payerName?: string;
     /** Who pays: exactly one typed email, phone, party ID, agent ID, or handle value. */

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

@@ -12,6 +12,8 @@ export interface CancelPaymentRequestsResponseDataAttributes {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -12,6 +12,8 @@ export interface DeclinedReqAttrs {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -8,6 +8,8 @@ export interface FulfilledReqAttrs {
     status: Natural.FulfilledReqStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -12,6 +12,8 @@ export interface IncomingReqAttrs {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -12,6 +12,8 @@ export interface NewPayReqAttrs {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -12,6 +12,8 @@ export interface PayReqAttrs {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -12,6 +12,8 @@ export interface PayReqDetailAttrs {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -69,7 +69,10 @@ export declare class PaymentsClient {
      *         },
      *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3",
      *         currency: "USD",
-     *         description: "Payment for Q4 2025 development work"
+     *         description: "Payment for Q4 2025 development work",
+     *         tags: {
+     *             "order_id": "ord_123"
+     *         }
      *     })
      */
     create(request: Natural.NewPaymentParams, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.NewPayment>;

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

@@ -182,7 +182,10 @@ export class PaymentsClient {
      *         },
      *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3",
      *         currency: "USD",
-     *         description: "Payment for Q4 2025 development work"
+     *         description: "Payment for Q4 2025 development work",
+     *         tags: {
+     *             "order_id": "ord_123"
+     *         }
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/payments/client/requests/NewPaymentParams.d.mts

@@ -10,7 +10,10 @@ import type * as Natural from "../../../../index.mjs";
  *         },
  *         customerPartyId: "pty_019cd1798d617f65a79cb965dda9eac3",
  *         currency: "USD",
- *         description: "Payment for Q4 2025 development work"
+ *         description: "Payment for Q4 2025 development work",
+ *         tags: {
+ *             "order_id": "ord_123"
+ *         }
  *     }
  */
 export interface NewPaymentParams {
@@ -26,6 +29,7 @@ export interface NewPaymentParams {
     currency?: Natural.NewPaymentCurrency;
     /** Payment description. Maximum 80 characters. */
     description?: string;
+    tags?: Record<string, string>;
     /** Source wallet ID (wal_*). Omit to pay from the sender party's default wallet. */
     walletId?: string;
     /** Natural notifications to disable for this request. "recipient" silences our message to the counterparty so you can deliver the returned link yourself; the person who initiated the request is always notified. Requires a delegated caller on payments and payment requests, which return 403 otherwise. Omit it, or send an empty array, to have Natural notify as usual. */

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

@@ -8,6 +8,8 @@ export interface CancelledPmtAttrs {
     status: Natural.CancelledPmtStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -8,6 +8,8 @@ export interface NewPaymentAttrs {
     status: Natural.NewPaymentStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -8,6 +8,8 @@ export interface PaymentAttrs {
     status: Natural.PaymentStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -8,6 +8,8 @@ export interface PaymentDetailAttrs {
     status: Natural.PaymentDetailStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -8,6 +8,8 @@ export interface CompletePaymentClaimSimulationsResponseDataAttributes {
     status: Natural.CompletePaymentClaimSimulationsResponseDataAttributesStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -12,6 +12,8 @@ export interface DeclinePaymentRequestSimulationsResponseDataAttributes {
     payerCanDecline: boolean;
     /** Free-form description provided at creation. Maximum 80 characters. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Display name of the party requesting payment. */
     requesterName: string | null;
     /** Email of the party requesting payment. */

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

@@ -8,6 +8,8 @@ export interface FulfillPaymentRequestSimulationsResponseDataAttributes {
     status: Natural.FulfillPaymentRequestSimulationsResponseDataAttributesStatus;
     /** Payment description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** When this payment was created. */
     createdAt: string;
     /** When this payment was last updated. */

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

@@ -14,6 +14,8 @@ export interface FundCustomerSimulationsResponseDataAttributes {
     rail: string | null;
     /** Transfer description. */
     description: string | null;
+    /** Metadata visible to anyone who can read the resource. */
+    tags: Record<string, string>;
     /** Masked external account number. */
     externalAccountDisplayMask: string | null;
     /** Expected availability time, when known. */