@cdx-forge/di-typescript-sdk 0.1.0-beta.1 → 1.0.0

package/dist/generated/src/apis/PaymentsApi.d.ts

@@ -0,0 +1,290 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import type { AchPayment, Payments, WirePayment } from '../models/index.js';
+export interface PaymentsApiCreateAchPaymentRequest {
+    loginId: string;
+    achPayment: AchPayment;
+}
+export interface PaymentsApiCreateWirePaymentRequest {
+    loginId: string;
+    wirePayment: WirePayment;
+}
+export interface PaymentsApiGetAchPaymentRequest {
+    loginId: string;
+    paymentId: string;
+}
+export interface PaymentsApiGetAchPaymentsRequest {
+    loginId: string;
+    fromDate: Date;
+    toDate: Date;
+    paymentStatus?: string;
+    paymentType?: string;
+}
+export interface PaymentsApiGetWirePaymentRequest {
+    loginId: string;
+    paymentId: string;
+}
+export interface PaymentsApiGetWirePaymentsRequest {
+    loginId: string;
+    fromDate: Date;
+    toDate: Date;
+    paymentStatus?: string;
+    paymentType?: string;
+}
+/**
+ * PaymentsApi - interface
+ *
+ * @export
+ * @interface PaymentsApiInterface
+ */
+export interface PaymentsApiInterface {
+    /**
+     * Creates request options for createAchPayment without sending the request
+     * @param {string} loginId Login ID of the user.
+     * @param {AchPayment} achPayment **Request body:** - The **examples** below provide sample bodies by **payment type** (ACH_COLLECTION or ACH_PAYMENT) and **sub-field** (SEC code). - **Transaction type:** ACH_PAYMENT uses **DEBIT**; ACH_COLLECTION uses **CREDIT**. - **Sub-fields (achSecCode):** COMMERCIAL_CCD, CONSUMER_PPD, PAYROLL_PPD, CHILD_SUPPORT_CCD (for ACH_PAYMENT); COMMERCIAL_CCD, CONSUMER_PPD (for ACH_COLLECTION). - **currencyCode:** Each **&#x60;achTransactions[].currencyCode&#x60;** must be a value from **&#x60;#/components/schemas/CurrencyCode&#x60;** (**enum**), e.g. **USD**. - **Required fields (payment):** paymentDescription, paymentType, transactionType, tinNumber, accountNumber, deliveryDate. - **Optional (payment):** paymentName — if omitted, the API uses the contactName (see **paymentName** on the payment object). - **Required fields (ACH):** achCompanyId, achSecCode, achTransactions. - **Required fields (achTransactions[]):** amount, currencyCode, contactAccountType, contactBankAchRoutingNumber, contactAccountNumber, contactName.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    createAchPaymentRequestOpts(requestParameters: PaymentsApiCreateAchPaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
+     * @summary Create an ACH Payment
+     * @param {string} loginId Login ID of the user.
+     * @param {AchPayment} achPayment **Request body:** - The **examples** below provide sample bodies by **payment type** (ACH_COLLECTION or ACH_PAYMENT) and **sub-field** (SEC code). - **Transaction type:** ACH_PAYMENT uses **DEBIT**; ACH_COLLECTION uses **CREDIT**. - **Sub-fields (achSecCode):** COMMERCIAL_CCD, CONSUMER_PPD, PAYROLL_PPD, CHILD_SUPPORT_CCD (for ACH_PAYMENT); COMMERCIAL_CCD, CONSUMER_PPD (for ACH_COLLECTION). - **currencyCode:** Each **&#x60;achTransactions[].currencyCode&#x60;** must be a value from **&#x60;#/components/schemas/CurrencyCode&#x60;** (**enum**), e.g. **USD**. - **Required fields (payment):** paymentDescription, paymentType, transactionType, tinNumber, accountNumber, deliveryDate. - **Optional (payment):** paymentName — if omitted, the API uses the contactName (see **paymentName** on the payment object). - **Required fields (ACH):** achCompanyId, achSecCode, achTransactions. - **Required fields (achTransactions[]):** amount, currencyCode, contactAccountType, contactBankAchRoutingNumber, contactAccountNumber, contactName.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    createAchPaymentRaw(requestParameters: PaymentsApiCreateAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AchPayment>>;
+    /**
+     * Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
+     * Create an ACH Payment
+     */
+    createAchPayment(requestParameters: PaymentsApiCreateAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AchPayment>;
+    /**
+     * Creates request options for createWirePayment without sending the request
+     * @param {string} loginId Login ID of the user.
+     * @param {WirePayment} wirePayment **Request body:** - The **examples** below provide sample bodies by **payment type** — WIRE_DOMESTIC or WIRE_INTERNATIONAL. - **WIRE_DOMESTIC:** Domestic wire (USD, US bank routing); **WIRE_INTERNATIONAL:** International wire (optional intermediary bank, optional foreign currency). - **Allowed countries / currencies:** **&#x60;#/components/schemas/CountryName&#x60;** — every **&#x60;address.country&#x60;** (beneficiary and beneficiary-bank addresses) must be a **full country name** from that schema’s **enum**, not a two-letter code. **&#x60;currencyCode&#x60;** and **&#x60;foreignCurrencyCode&#x60;** must be values from **&#x60;#/components/schemas/CurrencyCode&#x60;** (**enum**), e.g. **USD**, **EUR**. - **Required fields (payment):** paymentType, transactionType, tinNumber, accountNumber, deliveryDate. - **Optional (payment):** paymentName — if omitted, the API uses the beneficiaryName (see **paymentName** on the payment object); **paymentDescription** on the payment object. - **Required:** wireTransaction (shape must match **paymentType**; see **DomesticWireTransaction** / **InternationalWireTransaction** in schemas). - **WIRE_DOMESTIC — wireTransaction:** amount, **currencyCode** (per **&#x60;#/components/schemas/CurrencyCode&#x60;**); **beneficiaryDetails:** beneficiaryName, beneficiaryAccountNumber, **address** (address1, city, **country** &#x3D; allowed Address country **name** per **CountryName**); **beneficiaryBankDetails:** beneficiaryBankRoutingNumber, purposeOfWire (required when financial institution configures to require it). - **WIRE_INTERNATIONAL — wireTransaction:** amount, **currencyCode** (per **&#x60;#/components/schemas/CurrencyCode&#x60;**); **foreignCurrencyCode** (same allowed values as **currencyCode**, per **&#x60;#/components/schemas/CurrencyCode&#x60;**), **foreignCurrencyAmount**, **exchangeRate**; exactly one of **sendInForeignCurrency** or **transactInForeignCurrency** true; **beneficiaryDetails** as for domestic, including **purposeOfWire** (required when the financial institution configures to require it; same rule as **WIRE_DOMESTIC**); **beneficiaryBankDetails:** beneficiaryBankName, beneficiaryBankSwiftNumber, **address** (address1, city, **country** &#x3D; allowed Address country **name** per **CountryName**). Optional **intermediaryBankDetails** (only when the financial institution enables international intermediary — same FI configuration pattern as **purposeOfWire**): if **intermediaryBankType** is **DOMESTIC**, use **&#x60;#/components/schemas/IntermediaryBankDetailsIntlWireDomesticIntermediary&#x60;** (**intermediaryBankRoutingNumber** required; **intermediaryBankName** not used). If **INTERNATIONAL**, use **&#x60;#/components/schemas/IntermediaryBankDetailsIntlWireForeignIntermediary&#x60;** (**intermediaryBankName** and **intermediaryBankSwiftNumber** required).
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    createWirePaymentRequestOpts(requestParameters: PaymentsApiCreateWirePaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
+     * @summary Create a Wire Payment
+     * @param {string} loginId Login ID of the user.
+     * @param {WirePayment} wirePayment **Request body:** - The **examples** below provide sample bodies by **payment type** — WIRE_DOMESTIC or WIRE_INTERNATIONAL. - **WIRE_DOMESTIC:** Domestic wire (USD, US bank routing); **WIRE_INTERNATIONAL:** International wire (optional intermediary bank, optional foreign currency). - **Allowed countries / currencies:** **&#x60;#/components/schemas/CountryName&#x60;** — every **&#x60;address.country&#x60;** (beneficiary and beneficiary-bank addresses) must be a **full country name** from that schema’s **enum**, not a two-letter code. **&#x60;currencyCode&#x60;** and **&#x60;foreignCurrencyCode&#x60;** must be values from **&#x60;#/components/schemas/CurrencyCode&#x60;** (**enum**), e.g. **USD**, **EUR**. - **Required fields (payment):** paymentType, transactionType, tinNumber, accountNumber, deliveryDate. - **Optional (payment):** paymentName — if omitted, the API uses the beneficiaryName (see **paymentName** on the payment object); **paymentDescription** on the payment object. - **Required:** wireTransaction (shape must match **paymentType**; see **DomesticWireTransaction** / **InternationalWireTransaction** in schemas). - **WIRE_DOMESTIC — wireTransaction:** amount, **currencyCode** (per **&#x60;#/components/schemas/CurrencyCode&#x60;**); **beneficiaryDetails:** beneficiaryName, beneficiaryAccountNumber, **address** (address1, city, **country** &#x3D; allowed Address country **name** per **CountryName**); **beneficiaryBankDetails:** beneficiaryBankRoutingNumber, purposeOfWire (required when financial institution configures to require it). - **WIRE_INTERNATIONAL — wireTransaction:** amount, **currencyCode** (per **&#x60;#/components/schemas/CurrencyCode&#x60;**); **foreignCurrencyCode** (same allowed values as **currencyCode**, per **&#x60;#/components/schemas/CurrencyCode&#x60;**), **foreignCurrencyAmount**, **exchangeRate**; exactly one of **sendInForeignCurrency** or **transactInForeignCurrency** true; **beneficiaryDetails** as for domestic, including **purposeOfWire** (required when the financial institution configures to require it; same rule as **WIRE_DOMESTIC**); **beneficiaryBankDetails:** beneficiaryBankName, beneficiaryBankSwiftNumber, **address** (address1, city, **country** &#x3D; allowed Address country **name** per **CountryName**). Optional **intermediaryBankDetails** (only when the financial institution enables international intermediary — same FI configuration pattern as **purposeOfWire**): if **intermediaryBankType** is **DOMESTIC**, use **&#x60;#/components/schemas/IntermediaryBankDetailsIntlWireDomesticIntermediary&#x60;** (**intermediaryBankRoutingNumber** required; **intermediaryBankName** not used). If **INTERNATIONAL**, use **&#x60;#/components/schemas/IntermediaryBankDetailsIntlWireForeignIntermediary&#x60;** (**intermediaryBankName** and **intermediaryBankSwiftNumber** required).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    createWirePaymentRaw(requestParameters: PaymentsApiCreateWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WirePayment>>;
+    /**
+     * Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
+     * Create a Wire Payment
+     */
+    createWirePayment(requestParameters: PaymentsApiCreateWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WirePayment>;
+    /**
+     * Creates request options for getAchPayment without sending the request
+     * @param {string} loginId Login ID of the user.
+     * @param {string} paymentId Payment ID
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getAchPaymentRequestOpts(requestParameters: PaymentsApiGetAchPaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * @summary Get ACH Payment by Payment ID
+     * @param {string} loginId Login ID of the user.
+     * @param {string} paymentId Payment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getAchPaymentRaw(requestParameters: PaymentsApiGetAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AchPayment>>;
+    /**
+     * Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get ACH Payment by Payment ID
+     */
+    getAchPayment(requestParameters: PaymentsApiGetAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AchPayment>;
+    /**
+     * Creates request options for getAchPayments without sending the request
+     * @param {string} loginId Login ID of the user.
+     * @param {Date} fromDate Start date (YYYY-MM-DD).
+     * @param {Date} toDate End date (YYYY-MM-DD). Must be &gt;&#x3D; fromDate, max 30 days.
+     * @param {string} [paymentStatus] Comma-separated payment statuses (e.g. PENDING_COMPANY_APPROVAL, SCHEDULED, PROCESSED). Used only for list.
+     * @param {string} [paymentType] Comma-separated types to include. Allowed values ACH_PAYMENT, ACH_COLLECTION. Defaults to both when omitted. Used only for list.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getAchPaymentsRequestOpts(requestParameters: PaymentsApiGetAchPaymentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /v1/ach-payments/{paymentId}.
+     * @summary Get List of ACH Payments
+     * @param {string} loginId Login ID of the user.
+     * @param {Date} fromDate Start date (YYYY-MM-DD).
+     * @param {Date} toDate End date (YYYY-MM-DD). Must be &gt;&#x3D; fromDate, max 30 days.
+     * @param {string} [paymentStatus] Comma-separated payment statuses (e.g. PENDING_COMPANY_APPROVAL, SCHEDULED, PROCESSED). Used only for list.
+     * @param {string} [paymentType] Comma-separated types to include. Allowed values ACH_PAYMENT, ACH_COLLECTION. Defaults to both when omitted. Used only for list.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getAchPaymentsRaw(requestParameters: PaymentsApiGetAchPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Payments>>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /v1/ach-payments/{paymentId}.
+     * Get List of ACH Payments
+     */
+    getAchPayments(requestParameters: PaymentsApiGetAchPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Payments>;
+    /**
+     * Creates request options for getWirePayment without sending the request
+     * @param {string} loginId Login ID of the user.
+     * @param {string} paymentId Payment ID
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getWirePaymentRequestOpts(requestParameters: PaymentsApiGetWirePaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * @summary Get Wire Payment by Payment ID
+     * @param {string} loginId Login ID of the user.
+     * @param {string} paymentId Payment ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getWirePaymentRaw(requestParameters: PaymentsApiGetWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WirePayment>>;
+    /**
+     * Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get Wire Payment by Payment ID
+     */
+    getWirePayment(requestParameters: PaymentsApiGetWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WirePayment>;
+    /**
+     * Creates request options for getWirePayments without sending the request
+     * @param {string} loginId Login ID of the user.
+     * @param {Date} fromDate Start date (YYYY-MM-DD).
+     * @param {Date} toDate End date (YYYY-MM-DD). Must be &gt;&#x3D; fromDate, max 30 days.
+     * @param {string} [paymentStatus] Comma-separated payment statuses (e.g. PENDING_COMPANY_APPROVAL, SCHEDULED, PROCESSED). Used only for list.
+     * @param {string} [paymentType] Comma-separated types to include. Allowed values WIRE_DOMESTIC, WIRE_INTERNATIONAL. Defaults to both when omitted. Used only for list.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getWirePaymentsRequestOpts(requestParameters: PaymentsApiGetWirePaymentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /v1/wire-payments/{paymentId}.
+     * @summary Get List of Wire Payments
+     * @param {string} loginId Login ID of the user.
+     * @param {Date} fromDate Start date (YYYY-MM-DD).
+     * @param {Date} toDate End date (YYYY-MM-DD). Must be &gt;&#x3D; fromDate, max 30 days.
+     * @param {string} [paymentStatus] Comma-separated payment statuses (e.g. PENDING_COMPANY_APPROVAL, SCHEDULED, PROCESSED). Used only for list.
+     * @param {string} [paymentType] Comma-separated types to include. Allowed values WIRE_DOMESTIC, WIRE_INTERNATIONAL. Defaults to both when omitted. Used only for list.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentsApiInterface
+     */
+    getWirePaymentsRaw(requestParameters: PaymentsApiGetWirePaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Payments>>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /v1/wire-payments/{paymentId}.
+     * Get List of Wire Payments
+     */
+    getWirePayments(requestParameters: PaymentsApiGetWirePaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Payments>;
+}
+/**
+ *
+ */
+export declare class PaymentsApi extends runtime.BaseAPI implements PaymentsApiInterface {
+    /**
+     * Creates request options for createAchPayment without sending the request
+     */
+    createAchPaymentRequestOpts(requestParameters: PaymentsApiCreateAchPaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
+     * Create an ACH Payment
+     */
+    createAchPaymentRaw(requestParameters: PaymentsApiCreateAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AchPayment>>;
+    /**
+     * Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
+     * Create an ACH Payment
+     */
+    createAchPayment(requestParameters: PaymentsApiCreateAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AchPayment>;
+    /**
+     * Creates request options for createWirePayment without sending the request
+     */
+    createWirePaymentRequestOpts(requestParameters: PaymentsApiCreateWirePaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
+     * Create a Wire Payment
+     */
+    createWirePaymentRaw(requestParameters: PaymentsApiCreateWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WirePayment>>;
+    /**
+     * Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
+     * Create a Wire Payment
+     */
+    createWirePayment(requestParameters: PaymentsApiCreateWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WirePayment>;
+    /**
+     * Creates request options for getAchPayment without sending the request
+     */
+    getAchPaymentRequestOpts(requestParameters: PaymentsApiGetAchPaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get ACH Payment by Payment ID
+     */
+    getAchPaymentRaw(requestParameters: PaymentsApiGetAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AchPayment>>;
+    /**
+     * Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get ACH Payment by Payment ID
+     */
+    getAchPayment(requestParameters: PaymentsApiGetAchPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AchPayment>;
+    /**
+     * Creates request options for getAchPayments without sending the request
+     */
+    getAchPaymentsRequestOpts(requestParameters: PaymentsApiGetAchPaymentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /v1/ach-payments/{paymentId}.
+     * Get List of ACH Payments
+     */
+    getAchPaymentsRaw(requestParameters: PaymentsApiGetAchPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Payments>>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /v1/ach-payments/{paymentId}.
+     * Get List of ACH Payments
+     */
+    getAchPayments(requestParameters: PaymentsApiGetAchPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Payments>;
+    /**
+     * Creates request options for getWirePayment without sending the request
+     */
+    getWirePaymentRequestOpts(requestParameters: PaymentsApiGetWirePaymentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get Wire Payment by Payment ID
+     */
+    getWirePaymentRaw(requestParameters: PaymentsApiGetWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WirePayment>>;
+    /**
+     * Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get Wire Payment by Payment ID
+     */
+    getWirePayment(requestParameters: PaymentsApiGetWirePaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WirePayment>;
+    /**
+     * Creates request options for getWirePayments without sending the request
+     */
+    getWirePaymentsRequestOpts(requestParameters: PaymentsApiGetWirePaymentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /v1/wire-payments/{paymentId}.
+     * Get List of Wire Payments
+     */
+    getWirePaymentsRaw(requestParameters: PaymentsApiGetWirePaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Payments>>;
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /v1/wire-payments/{paymentId}.
+     * Get List of Wire Payments
+     */
+    getWirePayments(requestParameters: PaymentsApiGetWirePaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Payments>;
+}

package/dist/generated/src/apis/PaymentsApi.js

@@ -0,0 +1,339 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import { AchPaymentFromJSON, AchPaymentToJSON, PaymentsFromJSON, WirePaymentFromJSON, WirePaymentToJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class PaymentsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createAchPayment without sending the request
+     */
+    async createAchPaymentRequestOpts(requestParameters) {
+        if (requestParameters['loginId'] == null) {
+            throw new runtime.RequiredError('loginId', 'Required parameter "loginId" was null or undefined when calling createAchPayment().');
+        }
+        if (requestParameters['achPayment'] == null) {
+            throw new runtime.RequiredError('achPayment', 'Required parameter "achPayment" was null or undefined when calling createAchPayment().');
+        }
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/ach-payments`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AchPaymentToJSON(requestParameters['achPayment']),
+        };
+    }
+    /**
+     * Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
+     * Create an ACH Payment
+     */
+    async createAchPaymentRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createAchPaymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AchPaymentFromJSON(jsonValue));
+    }
+    /**
+     * Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
+     * Create an ACH Payment
+     */
+    async createAchPayment(requestParameters, initOverrides) {
+        const response = await this.createAchPaymentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createWirePayment without sending the request
+     */
+    async createWirePaymentRequestOpts(requestParameters) {
+        if (requestParameters['loginId'] == null) {
+            throw new runtime.RequiredError('loginId', 'Required parameter "loginId" was null or undefined when calling createWirePayment().');
+        }
+        if (requestParameters['wirePayment'] == null) {
+            throw new runtime.RequiredError('wirePayment', 'Required parameter "wirePayment" was null or undefined when calling createWirePayment().');
+        }
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/wire-payments`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: WirePaymentToJSON(requestParameters['wirePayment']),
+        };
+    }
+    /**
+     * Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
+     * Create a Wire Payment
+     */
+    async createWirePaymentRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createWirePaymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => WirePaymentFromJSON(jsonValue));
+    }
+    /**
+     * Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
+     * Create a Wire Payment
+     */
+    async createWirePayment(requestParameters, initOverrides) {
+        const response = await this.createWirePaymentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getAchPayment without sending the request
+     */
+    async getAchPaymentRequestOpts(requestParameters) {
+        if (requestParameters['loginId'] == null) {
+            throw new runtime.RequiredError('loginId', 'Required parameter "loginId" was null or undefined when calling getAchPayment().');
+        }
+        if (requestParameters['paymentId'] == null) {
+            throw new runtime.RequiredError('paymentId', 'Required parameter "paymentId" was null or undefined when calling getAchPayment().');
+        }
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/ach-payments/{paymentId}`;
+        urlPath = urlPath.replace(`{${"paymentId"}}`, encodeURIComponent(String(requestParameters['paymentId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get ACH Payment by Payment ID
+     */
+    async getAchPaymentRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getAchPaymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AchPaymentFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get ACH Payment by Payment ID
+     */
+    async getAchPayment(requestParameters, initOverrides) {
+        const response = await this.getAchPaymentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getAchPayments without sending the request
+     */
+    async getAchPaymentsRequestOpts(requestParameters) {
+        if (requestParameters['loginId'] == null) {
+            throw new runtime.RequiredError('loginId', 'Required parameter "loginId" was null or undefined when calling getAchPayments().');
+        }
+        if (requestParameters['fromDate'] == null) {
+            throw new runtime.RequiredError('fromDate', 'Required parameter "fromDate" was null or undefined when calling getAchPayments().');
+        }
+        if (requestParameters['toDate'] == null) {
+            throw new runtime.RequiredError('toDate', 'Required parameter "toDate" was null or undefined when calling getAchPayments().');
+        }
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['fromDate'] != null) {
+            queryParameters['fromDate'] = requestParameters['fromDate'].toISOString().substring(0, 10);
+        }
+        if (requestParameters['toDate'] != null) {
+            queryParameters['toDate'] = requestParameters['toDate'].toISOString().substring(0, 10);
+        }
+        if (requestParameters['paymentStatus'] != null) {
+            queryParameters['paymentStatus'] = requestParameters['paymentStatus'];
+        }
+        if (requestParameters['paymentType'] != null) {
+            queryParameters['paymentType'] = requestParameters['paymentType'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/ach-payments`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /v1/ach-payments/{paymentId}.
+     * Get List of ACH Payments
+     */
+    async getAchPaymentsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getAchPaymentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaymentsFromJSON(jsonValue));
+    }
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /v1/ach-payments/{paymentId}.
+     * Get List of ACH Payments
+     */
+    async getAchPayments(requestParameters, initOverrides) {
+        const response = await this.getAchPaymentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getWirePayment without sending the request
+     */
+    async getWirePaymentRequestOpts(requestParameters) {
+        if (requestParameters['loginId'] == null) {
+            throw new runtime.RequiredError('loginId', 'Required parameter "loginId" was null or undefined when calling getWirePayment().');
+        }
+        if (requestParameters['paymentId'] == null) {
+            throw new runtime.RequiredError('paymentId', 'Required parameter "paymentId" was null or undefined when calling getWirePayment().');
+        }
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/wire-payments/{paymentId}`;
+        urlPath = urlPath.replace(`{${"paymentId"}}`, encodeURIComponent(String(requestParameters['paymentId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get Wire Payment by Payment ID
+     */
+    async getWirePaymentRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getWirePaymentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => WirePaymentFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID. Only payments in Open API–visible statuses are returned; otherwise 404 is returned.
+     * Get Wire Payment by Payment ID
+     */
+    async getWirePayment(requestParameters, initOverrides) {
+        const response = await this.getWirePaymentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getWirePayments without sending the request
+     */
+    async getWirePaymentsRequestOpts(requestParameters) {
+        if (requestParameters['loginId'] == null) {
+            throw new runtime.RequiredError('loginId', 'Required parameter "loginId" was null or undefined when calling getWirePayments().');
+        }
+        if (requestParameters['fromDate'] == null) {
+            throw new runtime.RequiredError('fromDate', 'Required parameter "fromDate" was null or undefined when calling getWirePayments().');
+        }
+        if (requestParameters['toDate'] == null) {
+            throw new runtime.RequiredError('toDate', 'Required parameter "toDate" was null or undefined when calling getWirePayments().');
+        }
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['fromDate'] != null) {
+            queryParameters['fromDate'] = requestParameters['fromDate'].toISOString().substring(0, 10);
+        }
+        if (requestParameters['toDate'] != null) {
+            queryParameters['toDate'] = requestParameters['toDate'].toISOString().substring(0, 10);
+        }
+        if (requestParameters['paymentStatus'] != null) {
+            queryParameters['paymentStatus'] = requestParameters['paymentStatus'];
+        }
+        if (requestParameters['paymentType'] != null) {
+            queryParameters['paymentType'] = requestParameters['paymentType'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/wire-payments`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /v1/wire-payments/{paymentId}.
+     * Get List of Wire Payments
+     */
+    async getWirePaymentsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getWirePaymentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaymentsFromJSON(jsonValue));
+    }
+    /**
+     * Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /v1/wire-payments/{paymentId}.
+     * Get List of Wire Payments
+     */
+    async getWirePayments(requestParameters, initOverrides) {
+        const response = await this.getWirePaymentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+//# sourceMappingURL=PaymentsApi.js.map