increase 0.5.0 → 0.7.0

package/src/resources/real-time-payments-transfers.ts

@@ -0,0 +1,445 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from '.';
+import { Page, PageParams } from '../pagination';
+
+export class RealTimePaymentsTransfers extends APIResource {
+  /**
+   * Create a Real Time Payments Transfer
+   */
+  create(
+    body: RealTimePaymentsTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimePaymentsTransfer>> {
+    return this.post('/real_time_payments_transfers', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Real Time Payments Transfer
+   */
+  retrieve(
+    realTimePaymentsTransferId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimePaymentsTransfer>> {
+    return this.get(`/real_time_payments_transfers/${realTimePaymentsTransferId}`, options);
+  }
+
+  /**
+   * List Real Time Payments Transfers
+   */
+  list(
+    query?: RealTimePaymentsTransferListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RealTimePaymentsTransfersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<RealTimePaymentsTransfersPage>;
+  list(
+    query: RealTimePaymentsTransferListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RealTimePaymentsTransfersPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/real_time_payments_transfers', RealTimePaymentsTransfersPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class RealTimePaymentsTransfersPage extends Page<RealTimePaymentsTransfer> {}
+// alias so we can export it in the namespace
+type _RealTimePaymentsTransfersPage = RealTimePaymentsTransfersPage;
+
+/**
+ * Real Time Payments transfers move funds, within seconds, between your Increase
+ * account and any other account on the Real Time Payments network.
+ */
+export interface RealTimePaymentsTransfer {
+  /**
+   * The Real Time Payments Transfer's identifier.
+   */
+  id: string;
+
+  /**
+   * The Account from which the transfer was sent.
+   */
+  account_id: string;
+
+  /**
+   * The transfer amount in USD cents.
+   */
+  amount: number;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  approval: RealTimePaymentsTransfer.Approval | null;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  cancellation: RealTimePaymentsTransfer.Cancellation | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the transfer was created.
+   */
+  created_at: string;
+
+  /**
+   * The name of the transfer's recipient as provided by the sender.
+   */
+  creditor_name: string;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+   * currency. For real time payments transfers this is always equal to `USD`.
+   *
+   * - `CAD` - Canadian Dollar (CAD)
+   * - `CHF` - Swiss Franc (CHF)
+   * - `EUR` - Euro (EUR)
+   * - `GBP` - British Pound (GBP)
+   * - `JPY` - Japanese Yen (JPY)
+   * - `USD` - US Dollar (USD)
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+  /**
+   * The destination account number.
+   */
+  destination_account_number: string;
+
+  /**
+   * The destination American Bankers' Association (ABA) Routing Transit Number
+   * (RTN).
+   */
+  destination_routing_number: string;
+
+  /**
+   * The identifier of the External Account the transfer was made to, if any.
+   */
+  external_account_id: string | null;
+
+  /**
+   * If the transfer is rejected by Real Time Payments or the destination financial
+   * institution, this will contain supplemental details.
+   */
+  rejection: RealTimePaymentsTransfer.Rejection | null;
+
+  /**
+   * Unstructured information that will show on the recipient's bank statement.
+   */
+  remittance_information: string;
+
+  /**
+   * The Account Number the recipient will see as having sent the transfer.
+   */
+  source_account_number_id: string;
+
+  /**
+   * The lifecycle status of the transfer.
+   *
+   * - `pending_approval` - The transfer is pending approval.
+   * - `canceled` - The transfer has been canceled.
+   * - `pending_submission` - The transfer is queued to be submitted to Real Time
+   *   Payments.
+   * - `submitted` - The transfer has been submitted and is pending a response from
+   *   Real Time Payments.
+   * - `complete` - The transfer has been sent successfully and is complete.
+   * - `rejected` - The transfer was rejected by the network or the recipient's bank.
+   * - `requires_attention` - The transfer requires attention from an Increase
+   *   operator.
+   */
+  status:
+    | 'pending_approval'
+    | 'canceled'
+    | 'pending_submission'
+    | 'submitted'
+    | 'complete'
+    | 'rejected'
+    | 'requires_attention';
+
+  /**
+   * After the transfer is submitted to Real Time Payments, this will contain
+   * supplemental details.
+   */
+  submission: RealTimePaymentsTransfer.Submission | null;
+
+  /**
+   * The Transaction funding the transfer once it is complete.
+   */
+  transaction_id: string | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `real_time_payments_transfer`.
+   */
+  type: 'real_time_payments_transfer';
+
+  /**
+   * The unique identifier you chose for this transfer.
+   */
+  unique_identifier: string | null;
+}
+
+export namespace RealTimePaymentsTransfer {
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  export interface Approval {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was approved.
+     */
+    approved_at: string;
+
+    /**
+     * If the Transfer was approved by a user in the dashboard, the email address of
+     * that user.
+     */
+    approved_by: string | null;
+  }
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  export interface Cancellation {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Transfer was canceled.
+     */
+    canceled_at: string;
+
+    /**
+     * If the Transfer was canceled by a user in the dashboard, the email address of
+     * that user.
+     */
+    canceled_by: string | null;
+  }
+
+  /**
+   * If the transfer is rejected by Real Time Payments or the destination financial
+   * institution, this will contain supplemental details.
+   */
+  export interface Rejection {
+    /**
+     * Additional information about the rejection provided by the recipient bank when
+     * the `reject_reason_code` is `NARRATIVE`.
+     */
+    reject_reason_additional_information: string | null;
+
+    /**
+     * The reason the transfer was rejected as provided by the recipient bank or the
+     * Real Time Payments network.
+     *
+     * - `account_closed` - The destination account is closed. Corresponds to the Real
+     *   Time Payments reason code `AC04`.
+     * - `account_blocked` - The destination account is currently blocked from
+     *   receiving transactions. Corresponds to the Real Time Payments reason code
+     *   `AC06`.
+     * - `invalid_creditor_account_type` - The destination account is ineligible to
+     *   receive Real Time Payments transfers. Corresponds to the Real Time Payments
+     *   reason code `AC14`.
+     * - `invalid_creditor_account_number` - The destination account does not exist.
+     *   Corresponds to the Real Time Payments reason code `AC03`.
+     * - `invalid_creditor_financial_institution_identifier` - The destination routing
+     *   number is invalid. Corresponds to the Real Time Payments reason code `RC04`.
+     * - `end_customer_deceased` - The destination account holder is deceased.
+     *   Corresponds to the Real Time Payments reason code `MD07`.
+     * - `narrative` - The reason is provided as narrative information in the
+     *   additional information field.
+     * - `transaction_forbidden` - Real Time Payments transfers are not allowed to the
+     *   destination account. Corresponds to the Real Time Payments reason code `AG01`.
+     * - `transaction_type_not_supported` - Real Time Payments transfers are not
+     *   enabled for the destination account. Corresponds to the Real Time Payments
+     *   reason code `AG03`.
+     * - `unexpected_amount` - The amount of the transfer is different than expected by
+     *   the recipient. Corresponds to the Real Time Payments reason code `AM09`.
+     * - `amount_exceeds_bank_limits` - The amount is higher than the recipient is
+     *   authorized to send or receive. Corresponds to the Real Time Payments reason
+     *   code `AM14`.
+     * - `invalid_creditor_address` - The creditor's address is required, but missing
+     *   or invalid. Corresponds to the Real Time Payments reason code `BE04`.
+     * - `unknown_end_customer` - The specified creditor is unknown. Corresponds to the
+     *   Real Time Payments reason code `BE06`.
+     * - `invalid_debtor_address` - The debtor's address is required, but missing or
+     *   invalid. Corresponds to the Real Time Payments reason code `BE07`.
+     * - `timeout` - There was a timeout processing the transfer. Corresponds to the
+     *   Real Time Payments reason code `DS24`.
+     * - `unsupported_message_for_recipient` - Real Time Payments transfers are not
+     *   enabled for the destination account. Corresponds to the Real Time Payments
+     *   reason code `NOAT`.
+     * - `recipient_connection_not_available` - The destination financial institution
+     *   is currently not connected to Real Time Payments. Corresponds to the Real Time
+     *   Payments reason code `9912`.
+     * - `real_time_payments_suspended` - Real Time Payments is currently unavailable.
+     *   Corresponds to the Real Time Payments reason code `9948`.
+     * - `instructed_agent_signed_off` - The destination financial institution is
+     *   currently signed off of Real Time Payments. Corresponds to the Real Time
+     *   Payments reason code `9910`.
+     * - `processing_error` - The transfer was rejected due to an internal Increase
+     *   issue. We have been notified.
+     * - `other` - Some other error or issue has occurred.
+     */
+    reject_reason_code:
+      | 'account_closed'
+      | 'account_blocked'
+      | 'invalid_creditor_account_type'
+      | 'invalid_creditor_account_number'
+      | 'invalid_creditor_financial_institution_identifier'
+      | 'end_customer_deceased'
+      | 'narrative'
+      | 'transaction_forbidden'
+      | 'transaction_type_not_supported'
+      | 'unexpected_amount'
+      | 'amount_exceeds_bank_limits'
+      | 'invalid_creditor_address'
+      | 'unknown_end_customer'
+      | 'invalid_debtor_address'
+      | 'timeout'
+      | 'unsupported_message_for_recipient'
+      | 'recipient_connection_not_available'
+      | 'real_time_payments_suspended'
+      | 'instructed_agent_signed_off'
+      | 'processing_error'
+      | 'other';
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was rejected.
+     */
+    rejected_at: string | null;
+  }
+
+  /**
+   * After the transfer is submitted to Real Time Payments, this will contain
+   * supplemental details.
+   */
+  export interface Submission {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was submitted to The Clearing House.
+     */
+    submitted_at: string | null;
+
+    /**
+     * The Real Time Payments network identification of the transfer.
+     */
+    transaction_identification: string;
+  }
+}
+
+export interface RealTimePaymentsTransferCreateParams {
+  /**
+   * The transfer amount in USD cents. For Real Time Payments transfers, must be
+   * positive.
+   */
+  amount: number;
+
+  /**
+   * The name of the transfer's recipient.
+   */
+  creditor_name: string;
+
+  /**
+   * Unstructured information that will show on the recipient's bank statement.
+   */
+  remittance_information: string;
+
+  /**
+   * The identifier of the Account Number from which to send the transfer.
+   */
+  source_account_number_id: string;
+
+  /**
+   * The destination account number.
+   */
+  destination_account_number?: string;
+
+  /**
+   * The destination American Bankers' Association (ABA) Routing Transit Number
+   * (RTN).
+   */
+  destination_routing_number?: string;
+
+  /**
+   * The ID of an External Account to initiate a transfer to. If this parameter is
+   * provided, `destination_account_number` and `destination_routing_number` must be
+   * absent.
+   */
+  external_account_id?: string;
+
+  /**
+   * Whether the transfer requires explicit approval via the dashboard or API.
+   */
+  require_approval?: boolean;
+
+  /**
+   * A unique identifier you choose for the transfer. Reusing this identifer for
+   * another transfer will result in an error. You can query for the transfer
+   * associated with this identifier using the List endpoint.
+   */
+  unique_identifier?: string;
+}
+
+export interface RealTimePaymentsTransferListParams extends PageParams {
+  /**
+   * Filter Real Time Payments Transfers to those belonging to the specified Account.
+   */
+  account_id?: string;
+
+  created_at?: RealTimePaymentsTransferListParams.CreatedAt;
+
+  /**
+   * Filter Real Time Payments Transfers to those made to the specified External
+   * Account.
+   */
+  external_account_id?: string;
+
+  /**
+   * Filter ACH Transfers to the one with the specified unique identifier.
+   */
+  unique_identifier?: string;
+}
+
+export namespace RealTimePaymentsTransferListParams {
+  export interface CreatedAt {
+    /**
+     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    after?: string;
+
+    /**
+     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    before?: string;
+
+    /**
+     * Return results on or after this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_after?: string;
+
+    /**
+     * Return results on or before this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_before?: string;
+  }
+}
+
+export namespace RealTimePaymentsTransfers {
+  export import RealTimePaymentsTransfer = API.RealTimePaymentsTransfer;
+  export type RealTimePaymentsTransfersPage = _RealTimePaymentsTransfersPage;
+  export import RealTimePaymentsTransferCreateParams = API.RealTimePaymentsTransferCreateParams;
+  export import RealTimePaymentsTransferListParams = API.RealTimePaymentsTransferListParams;
+}

package/src/resources/routing-numbers.ts

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import * as API from '.';
+import { Page, PageParams } from '../pagination';
+
+export class RoutingNumbers extends APIResource {
+  /**
+   * You can use this API to confirm if a routing number is valid, such as when a
+   * user is providing you with bank account details. Since routing numbers uniquely
+   * identify a bank, this will always return 0 or 1 entry. In Sandbox, the only
+   * valid routing number for this method is 110000000.
+   */
+  list(query: RoutingNumberListParams, options?: Core.RequestOptions): Core.PagePromise<RoutingNumbersPage> {
+    return this.getAPIList('/routing_numbers', RoutingNumbersPage, { query, ...options });
+  }
+}
+
+export class RoutingNumbersPage extends Page<RoutingNumber> {}
+// alias so we can export it in the namespace
+type _RoutingNumbersPage = RoutingNumbersPage;
+
+/**
+ * Routing numbers are used to identify your bank in a financial transaction.
+ */
+export interface RoutingNumber {
+  /**
+   * This routing number's support for ACH Transfers.
+   *
+   * - `supported` - The routing number can receive this transfer type.
+   * - `not_supported` - The routing number cannot receive this transfer type.
+   */
+  ach_transfers: 'supported' | 'not_supported';
+
+  /**
+   * The name of the financial institution belonging to a routing number.
+   */
+  name: string;
+
+  /**
+   * This routing number's support for Real Time Payments Transfers.
+   *
+   * - `supported` - The routing number can receive this transfer type.
+   * - `not_supported` - The routing number cannot receive this transfer type.
+   */
+  real_time_payments_transfers: 'supported' | 'not_supported';
+
+  /**
+   * The nine digit routing number identifier.
+   */
+  routing_number: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `routing_number`.
+   */
+  type: 'routing_number';
+
+  /**
+   * This routing number's support for Wire Transfers.
+   *
+   * - `supported` - The routing number can receive this transfer type.
+   * - `not_supported` - The routing number cannot receive this transfer type.
+   */
+  wire_transfers: 'supported' | 'not_supported';
+}
+
+export interface RoutingNumberListParams extends PageParams {
+  /**
+   * Filter financial institutions by routing number.
+   */
+  routing_number: string;
+}
+
+export namespace RoutingNumbers {
+  export import RoutingNumber = API.RoutingNumber;
+  export type RoutingNumbersPage = _RoutingNumbersPage;
+  export import RoutingNumberListParams = API.RoutingNumberListParams;
+}

package/src/resources/shared.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless.
+
+/**
+ * The method used to enter the cardholder's primary account number and card
+ * expiration date
+ *
+ * - `manual` - Manual key entry
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+ *   value
+ * - `optical_code` - Optical code
+ * - `integrated_circuit_card` - Contact chip card
+ * - `contactless` - Contactless read of chip card
+ * - `credential_on_file` - Transaction iniated using a credential that has
+ *   previously been stored on file
+ * - `magnetic_stripe` - Magnetic stripe read
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+ *   verification value
+ */
+export type PointOfServiceEntryMode =
+  | 'manual'
+  | 'magnetic_stripe_no_cvv'
+  | 'optical_code'
+  | 'integrated_circuit_card'
+  | 'contactless'
+  | 'credential_on_file'
+  | 'magnetic_stripe'
+  | 'contactless_magnetic_stripe'
+  | 'integrated_circuit_card_no_cvv'
+  | null;

package/src/resources/simulations/account-statements.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as AccountStatements_ from '../account-statements';
+import * as API from '.';
+
+export class AccountStatements extends APIResource {
+  /**
+   * Simulates an [Account Statement](#account-statements) being created for an
+   * account. In production, Account Statements are generated once per month.
+   */
+  create(
+    body: AccountStatementCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountStatements_.AccountStatement>> {
+    return this.post('/simulations/account_statements', { body, ...options });
+  }
+}
+
+export interface AccountStatementCreateParams {
+  /**
+   * The identifier of the Account the statement is for.
+   */
+  account_id: string;
+}
+
+export namespace AccountStatements {
+  export import AccountStatementCreateParams = API.AccountStatementCreateParams;
+}

package/src/resources/simulations/account-transfers.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as AccountTransfers_ from '../account-transfers';
+
+export class AccountTransfers extends APIResource {
+  /**
+   * If your account is configured to require approval for each transfer, this
+   * endpoint simulates the approval of an [Account Transfer](#account-transfers).
+   * You can also approve sandbox Account Transfers in the dashboard. This transfer
+   * must first have a `status` of `pending_approval`.
+   */
+  complete(
+    accountTransferId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountTransfers_.AccountTransfer>> {
+    return this.post(`/simulations/account_transfers/${accountTransferId}/complete`, options);
+  }
+}