@naturalpay/sdk 0.1.4 → 0.2.1

package/src/resources/payments.ts

@@ -0,0 +1,228 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Payment and transaction operations
+ */
+export class Payments extends APIResource {
+  /**
+   * Create a payment with delegation validation and limit enforcement.
+   *
+   * @example
+   * ```ts
+   * const payment = await client.payments.create({
+   *   amount: 1,
+   *   counterparty: 'counterparty',
+   *   'Idempotency-Key': 'Idempotency-Key',
+   * });
+   * ```
+   */
+  create(params: PaymentCreateParams, options?: RequestOptions): APIPromise<PaymentCreateResponse> {
+    const {
+      'Idempotency-Key': idempotencyKey,
+      'X-Agent-ID': xAgentID,
+      'X-Instance-ID': xInstanceID,
+      ...body
+    } = params;
+    return this._client.post('/payments', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface PaymentCreateResponse {
+  data: PaymentCreateResponse.Data;
+}
+
+export namespace PaymentCreateResponse {
+  export interface Data {
+    /**
+     * Resource ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource relationships
+     */
+    relationships: Data.Relationships;
+
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * Amount in cents
+       */
+      amount: number;
+
+      /**
+       * Claim link for unclaimed payments
+       */
+      claimLink: string | null;
+
+      /**
+       * When this payment was created
+       */
+      createdAt: string;
+
+      /**
+       * Currency code
+       */
+      currency: string;
+
+      /**
+       * Payment description
+       */
+      description: string | null;
+
+      /**
+       * Payment status
+       */
+      status: 'PROCESSING' | 'PENDING_CLAIM' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
+
+      /**
+       * When this payment was last updated
+       */
+      updatedAt: string;
+    }
+
+    /**
+     * Resource relationships
+     */
+    export interface Relationships {
+      /**
+       * Party receiving the payment
+       */
+      counterparty: Relationships.Counterparty;
+
+      /**
+       * Party that made the payment
+       */
+      customerParty: Relationships.CustomerParty;
+    }
+
+    export namespace Relationships {
+      /**
+       * Party receiving the payment
+       */
+      export interface Counterparty {
+        /**
+         * Related resource identifier
+         */
+        data: Counterparty.Data | null;
+      }
+
+      export namespace Counterparty {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: string;
+        }
+      }
+
+      /**
+       * Party that made the payment
+       */
+      export interface CustomerParty {
+        /**
+         * Related resource identifier
+         */
+        data: CustomerParty.Data;
+      }
+
+      export namespace CustomerParty {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: string;
+        }
+      }
+    }
+  }
+}
+
+export interface PaymentCreateParams {
+  /**
+   * Body param: Amount in cents
+   */
+  amount: number;
+
+  /**
+   * Body param: Recipient: party ID (pty\_\*), email, or phone
+   */
+  counterparty: string;
+
+  /**
+   * Header param: Unique key for idempotent request handling. If a request with the
+   * same key was already processed, the original response is returned.
+   */
+  'Idempotency-Key': string;
+
+  /**
+   * Body param: Currency code
+   */
+  currency?: 'USD';
+
+  /**
+   * Body param: Sender party ID (pty\_\*). Omit to send from your own wallet;
+   * provide for delegated payments on behalf of a customer.
+   */
+  customerPartyId?: string;
+
+  /**
+   * Body param: Payment description
+   */
+  description?: string;
+
+  /**
+   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Required when X-Agent-ID is present. Session or conversation ID
+   * for agent observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export declare namespace Payments {
+  export {
+    type PaymentCreateResponse as PaymentCreateResponse,
+    type PaymentCreateParams as PaymentCreateParams,
+  };
+}