increase 0.4.0 → 0.5.0

package/dist/esm/resources/real-time-decisions.d.ts

@@ -0,0 +1,330 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as Shared from '../resources/shared.js';
+import * as API from './index.js';
+export declare class RealTimeDecisions extends APIResource {
+  /**
+   * Retrieve a Real-Time Decision
+   */
+  retrieve(
+    realTimeDecisionId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimeDecision>>;
+  /**
+   * Action a Real-Time Decision
+   */
+  action(
+    realTimeDecisionId: string,
+    body: RealTimeDecisionActionParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimeDecision>>;
+}
+/**
+ * Real Time Decisions are created when your application needs to take action in
+ * real-time to some event such as a card authorization. Real time decisions are
+ * currently in beta; please contact support@increase.com if you're interested in
+ * trying them out!
+ */
+export interface RealTimeDecision {
+  /**
+   * The Real-Time Decision identifier.
+   */
+  id: string;
+  /**
+   * Fields related to a card authorization.
+   */
+  card_authorization: RealTimeDecision.CardAuthorization | null;
+  /**
+   * The category of the Real-Time Decision.
+   */
+  category:
+    | 'card_authorization_requested'
+    | 'digital_wallet_token_requested'
+    | 'digital_wallet_authentication_requested';
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the Real-Time Decision was created.
+   */
+  created_at: string;
+  /**
+   * Fields related to a digital wallet authentication attempt.
+   */
+  digital_wallet_authentication: RealTimeDecision.DigitalWalletAuthentication | null;
+  /**
+   * Fields related to a digital wallet token provisioning attempt.
+   */
+  digital_wallet_token: RealTimeDecision.DigitalWalletToken | null;
+  /**
+   * The status of the Real-Time Decision.
+   */
+  status: 'pending' | 'responded' | 'timed_out';
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * your application can no longer respond to the Real-Time Decision.
+   */
+  timeout_at: string;
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `real_time_decision`.
+   */
+  type: 'real_time_decision';
+}
+export declare namespace RealTimeDecision {
+  /**
+   * Fields related to a card authorization.
+   */
+  interface CardAuthorization {
+    /**
+     * The identifier of the Account the authorization will debit.
+     */
+    account_id: string;
+    /**
+     * The identifier of the Card that is being authorized.
+     */
+    card_id: string;
+    /**
+     * Whether or not the authorization was approved.
+     */
+    decision: 'approve' | 'decline' | null;
+    /**
+     * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+     * is transacting with.
+     */
+    merchant_acceptor_id: string;
+    /**
+     * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+     * card is transacting with.
+     */
+    merchant_category_code: string | null;
+    /**
+     * The city the merchant resides in.
+     */
+    merchant_city: string | null;
+    /**
+     * The country the merchant resides in.
+     */
+    merchant_country: string | null;
+    /**
+     * The merchant descriptor of the merchant the card is transacting with.
+     */
+    merchant_descriptor: string;
+    /**
+     * The payment network used to process this card authorization
+     */
+    network: 'visa';
+    /**
+     * Fields specific to the `network`
+     */
+    network_details: CardAuthorization.NetworkDetails;
+    /**
+     * The amount of the attempted authorization in the currency the card user sees at
+     * the time of purchase, in the minor unit of that currency. For dollars, for
+     * example, this is cents.
+     */
+    presentment_amount: number;
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
+     * user sees at the time of purchase.
+     */
+    presentment_currency: string;
+    /**
+     * The amount of the attempted authorization in the currency it will be settled in.
+     * This currency is the same as that of the Account the card belongs to.
+     */
+    settlement_amount: number;
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
+     * transaction will be settled in.
+     */
+    settlement_currency: string;
+  }
+  namespace CardAuthorization {
+    /**
+     * Fields specific to the `network`
+     */
+    interface NetworkDetails {
+      /**
+       * Fields specific to the `visa` network
+       */
+      visa: NetworkDetails.Visa;
+    }
+    namespace NetworkDetails {
+      /**
+       * Fields specific to the `visa` network
+       */
+      interface Visa {
+        /**
+         * For electronic commerce transactions, this identifies the level of security used
+         * in obtaining the customer's payment credential. For mail or telephone order
+         * transactions, identifies the type of mail or telephone order.
+         */
+        electronic_commerce_indicator:
+          | 'mail_phone_order'
+          | 'recurring'
+          | 'installment'
+          | 'unknown_mail_phone_order'
+          | 'secure_electronic_commerce'
+          | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
+          | 'non_authenticated_security_transaction'
+          | 'non_secure_transaction'
+          | null;
+        /**
+         * The method used to enter the cardholder's primary account number and card
+         * expiration date
+         */
+        point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
+      }
+    }
+  }
+  /**
+   * Fields related to a digital wallet authentication attempt.
+   */
+  interface DigitalWalletAuthentication {
+    /**
+     * The identifier of the Card that is being tokenized.
+     */
+    card_id: string;
+    /**
+     * The channel to send the card user their one-time passcode.
+     */
+    channel: 'sms' | 'email';
+    /**
+     * The digital wallet app being used.
+     */
+    digital_wallet: 'apple_pay' | 'google_pay';
+    /**
+     * The email to send the one-time passcode to if `channel` is equal to `email`.
+     */
+    email: string | null;
+    /**
+     * The one-time passcode to send the card user.
+     */
+    one_time_passcode: string;
+    /**
+     * The phone number to send the one-time passcode to if `channel` is equal to
+     * `sms`.
+     */
+    phone: string | null;
+    /**
+     * Whether your application successfully delivered the one-time passcode.
+     */
+    result: 'success' | 'failure' | null;
+  }
+  /**
+   * Fields related to a digital wallet token provisioning attempt.
+   */
+  interface DigitalWalletToken {
+    /**
+     * The identifier of the Card that is being tokenized.
+     */
+    card_id: string;
+    /**
+     * The identifier of the Card Profile that was set via the real time decision. This
+     * will be null until the real time decision is responded to or if the real time
+     * decision did not set a card profile.
+     */
+    card_profile_id: string | null;
+    /**
+     * Whether or not the provisioning request was approved. This will be null until
+     * the real time decision is responded to.
+     */
+    decision: 'approve' | 'decline' | null;
+    /**
+     * The digital wallet app being used.
+     */
+    digital_wallet: 'apple_pay' | 'google_pay';
+  }
+}
+export interface RealTimeDecisionActionParams {
+  /**
+   * If the Real-Time Decision relates to a card authorization attempt, this object
+   * contains your response to the authorization.
+   */
+  card_authorization?: RealTimeDecisionActionParams.CardAuthorization;
+  /**
+   * If the Real-Time Decision relates to a digital wallet authentication attempt,
+   * this object contains your response to the authentication.
+   */
+  digital_wallet_authentication?: RealTimeDecisionActionParams.DigitalWalletAuthentication;
+  /**
+   * If the Real-Time Decision relates to a digital wallet token provisioning
+   * attempt, this object contains your response to the attempt.
+   */
+  digital_wallet_token?: RealTimeDecisionActionParams.DigitalWalletToken;
+}
+export declare namespace RealTimeDecisionActionParams {
+  /**
+   * If the Real-Time Decision relates to a card authorization attempt, this object
+   * contains your response to the authorization.
+   */
+  interface CardAuthorization {
+    /**
+     * Whether the card authorization should be approved or declined.
+     */
+    decision: 'approve' | 'decline';
+  }
+  /**
+   * If the Real-Time Decision relates to a digital wallet authentication attempt,
+   * this object contains your response to the authentication.
+   */
+  interface DigitalWalletAuthentication {
+    /**
+     * Whether your application was able to deliver the one-time passcode.
+     */
+    result: 'success' | 'failure';
+  }
+  /**
+   * If the Real-Time Decision relates to a digital wallet token provisioning
+   * attempt, this object contains your response to the attempt.
+   */
+  interface DigitalWalletToken {
+    /**
+     * If your application approves the provisioning attempt, this contains metadata
+     * about the digital wallet token that will be generated.
+     */
+    approval?: DigitalWalletToken.Approval;
+    /**
+     * If your application declines the provisioning attempt, this contains details
+     * about the decline.
+     */
+    decline?: DigitalWalletToken.Decline;
+  }
+  namespace DigitalWalletToken {
+    /**
+     * If your application approves the provisioning attempt, this contains metadata
+     * about the digital wallet token that will be generated.
+     */
+    interface Approval {
+      /**
+       * The identifier of the Card Profile to assign to the Digital Wallet token.
+       */
+      card_profile_id: string;
+      /**
+       * An email address that can be used to verify the cardholder via one-time
+       * passcode.
+       */
+      email?: string;
+      /**
+       * A phone number that can be used to verify the cardholder via one-time passcode
+       * over SMS.
+       */
+      phone?: string;
+    }
+    /**
+     * If your application declines the provisioning attempt, this contains details
+     * about the decline.
+     */
+    interface Decline {
+      /**
+       * Why the tokenization attempt was declined. This is for logging purposes only and
+       * is not displayed to the end-user.
+       */
+      reason?: string;
+    }
+  }
+}
+export declare namespace RealTimeDecisions {
+  export import RealTimeDecision = API.RealTimeDecision;
+  export import RealTimeDecisionActionParams = API.RealTimeDecisionActionParams;
+}
+//# sourceMappingURL=real-time-decisions.d.ts.map

package/dist/esm/resources/real-time-decisions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"real-time-decisions.d.ts","sourceRoot":"","sources":["../../../resources/real-time-decisions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAE1B,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,QAAQ,CACN,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAI9C;;OAEG;IACH,MAAM,CACJ,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;CAG/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,kBAAkB,EAAE,gBAAgB,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,QAAQ,EACJ,8BAA8B,GAC9B,gCAAgC,GAChC,yCAAyC,CAAC;IAE9C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,6BAA6B,EAAE,gBAAgB,CAAC,2BAA2B,GAAG,IAAI,CAAC;IAEnF;;OAEG;IACH,oBAAoB,EAAE,gBAAgB,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAEjE;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC;IAE9C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;QAEvC;;;WAGG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,eAAe,EAAE,iBAAiB,CAAC,cAAc,CAAC;QAElD;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;KAC7B;IAED,UAAiB,iBAAiB,CAAC;QACjC;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;SAC3B;QAED,UAAiB,cAAc,CAAC;YAC9B;;eAEG;YACH,UAAiB,IAAI;gBACnB;;;;mBAIG;gBACH,6BAA6B,EACzB,kBAAkB,GAClB,WAAW,GACX,aAAa,GACb,0BAA0B,GAC1B,4BAA4B,GAC5B,gEAAgE,GAChE,wCAAwC,GACxC,wBAAwB,GACxB,IAAI,CAAC;gBAET;;;mBAGG;gBACH,2BAA2B,EAAE,MAAM,CAAC,uBAAuB,GAAG,IAAI,CAAC;aACpE;SACF;KACF;IAED;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC;QAEzB;;WAEG;QACH,cAAc,EAAE,WAAW,GAAG,YAAY,CAAC;QAE3C;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;KACtC;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;WAIG;QACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,cAAc,EAAE,WAAW,GAAG,YAAY,CAAC;KAC5C;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,4BAA4B,CAAC,iBAAiB,CAAC;IAEpE;;;OAGG;IACH,6BAA6B,CAAC,EAAE,4BAA4B,CAAC,2BAA2B,CAAC;IAEzF;;;OAGG;IACH,oBAAoB,CAAC,EAAE,4BAA4B,CAAC,kBAAkB,CAAC;CACxE;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;KACjC;IAED;;;OAGG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;KAC/B;IAED;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;;WAGG;QACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;QAEvC;;;WAGG;QACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;KACtC;IAED,UAAiB,kBAAkB,CAAC;QAClC;;;WAGG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;KACF;CACF;AAED,yBAAiB,iBAAiB,CAAC;IACjC,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,4BAA4B,GAAG,GAAG,CAAC,4BAA4B,CAAC;CAC/E"}

package/dist/esm/resources/real-time-decisions.js

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '../resource.js';
+export class RealTimeDecisions extends APIResource {
+  /**
+   * Retrieve a Real-Time Decision
+   */
+  retrieve(realTimeDecisionId, options) {
+    return this.get(`/real_time_decisions/${realTimeDecisionId}`, options);
+  }
+  /**
+   * Action a Real-Time Decision
+   */
+  action(realTimeDecisionId, body, options) {
+    return this.post(`/real_time_decisions/${realTimeDecisionId}/action`, { body, ...options });
+  }
+}
+(function (RealTimeDecisions) {})(RealTimeDecisions || (RealTimeDecisions = {}));
+//# sourceMappingURL=real-time-decisions.js.map

package/dist/esm/resources/real-time-decisions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"real-time-decisions.js","sourceRoot":"","sources":["../../../resources/real-time-decisions.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAIzC,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,QAAQ,CACN,kBAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,kBAA0B,EAC1B,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,wBAAwB,kBAAkB,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF;AAkWD,WAAiB,iBAAiB;AAGlC,CAAC,EAHgB,iBAAiB,KAAjB,iBAAiB,QAGjC"}

package/dist/esm/resources/real-time-payments-transfers.d.ts

@@ -0,0 +1,294 @@
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
+export declare class RealTimePaymentsTransfers extends APIResource {
+  /**
+   * Create a Real Time Payments Transfer
+   */
+  create(
+    body: RealTimePaymentsTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimePaymentsTransfer>>;
+  /**
+   * Retrieve a Real Time Payments Transfer
+   */
+  retrieve(
+    realTimePaymentsTransferId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimePaymentsTransfer>>;
+  /**
+   * List Real Time Payments Transfers
+   */
+  list(
+    query?: RealTimePaymentsTransferListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RealTimePaymentsTransfersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<RealTimePaymentsTransfersPage>;
+}
+export declare class RealTimePaymentsTransfersPage extends Page<RealTimePaymentsTransfer> {}
+/**
+ * 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`.
+   */
+  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.
+   */
+  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';
+}
+export declare namespace RealTimePaymentsTransfer {
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  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.
+   */
+  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.
+   */
+  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.
+     */
+    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.
+   */
+  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;
+}
+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;
+}
+export declare namespace RealTimePaymentsTransferListParams {
+  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 declare namespace RealTimePaymentsTransfers {
+  export import RealTimePaymentsTransfer = API.RealTimePaymentsTransfer;
+  export import RealTimePaymentsTransfersPage = API.RealTimePaymentsTransfersPage;
+  export import RealTimePaymentsTransferCreateParams = API.RealTimePaymentsTransferCreateParams;
+  export import RealTimePaymentsTransferListParams = API.RealTimePaymentsTransferListParams;
+}
+//# sourceMappingURL=real-time-payments-transfers.d.ts.map

package/dist/esm/resources/real-time-payments-transfers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"real-time-payments-transfers.d.ts","sourceRoot":"","sources":["../../../resources/real-time-payments-transfers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEhD,qBAAa,yBAA0B,SAAQ,WAAW;IACxD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;IAItD;;OAEG;IACH,QAAQ,CACN,0BAA0B,EAAE,MAAM,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;IAItD;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC;IAClD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC;CAarF;AAED,qBAAa,6BAA8B,SAAQ,IAAI,CAAC,wBAAwB,CAAC;CAAG;AAEpF;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,wBAAwB,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,YAAY,EAAE,wBAAwB,CAAC,YAAY,GAAG,IAAI,CAAC;IAE3D;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAExD;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,SAAS,EAAE,wBAAwB,CAAC,SAAS,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,MAAM,EACF,kBAAkB,GAClB,UAAU,GACV,oBAAoB,GACpB,WAAW,GACX,UAAU,GACV,UAAU,GACV,oBAAoB,CAAC;IAEzB;;;OAGG;IACH,UAAU,EAAE,wBAAwB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,6BAA6B,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,oCAAoC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpD;;;WAGG;QACH,kBAAkB,EACd,gBAAgB,GAChB,iBAAiB,GACjB,+BAA+B,GAC/B,iCAAiC,GACjC,mDAAmD,GACnD,uBAAuB,GACvB,WAAW,GACX,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,4BAA4B,GAC5B,0BAA0B,GAC1B,sBAAsB,GACtB,wBAAwB,GACxB,SAAS,GACT,mCAAmC,GACnC,oCAAoC,GACpC,8BAA8B,GAC9B,6BAA6B,GAC7B,kBAAkB,GAClB,OAAO,CAAC;QAEZ;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,0BAA0B,EAAE,MAAM,CAAC;KACpC;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,kCAAmC,SAAQ,UAAU;IACpE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,kCAAkC,CAAC,SAAS,CAAC;IAE1D;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,yBAAiB,kCAAkC,CAAC;IAClD,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAED,yBAAiB,yBAAyB,CAAC;IACzC,MAAM,QAAQ,wBAAwB,GAAG,GAAG,CAAC,wBAAwB,CAAC;IACtE,MAAM,QAAQ,6BAA6B,GAAG,GAAG,CAAC,6BAA6B,CAAC;IAChF,MAAM,QAAQ,oCAAoC,GAAG,GAAG,CAAC,oCAAoC,CAAC;IAC9F,MAAM,QAAQ,kCAAkC,GAAG,GAAG,CAAC,kCAAkC,CAAC;CAC3F"}