fix(api): Modify return type of returns API to payment-transaction

feat(api): Add Payoff Details

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 172
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-e1901db484e520cc1f6aa88c8b00d0fcda30c8f9e5ea562a12b9edfc3fb3b6d6.yml
-openapi_spec_hash: 59c317749628f3ed4cc7911b68f6351f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-9791980619fc7ce8afb01f77dfe3c660a540975327378287cb666136ae4b0a99.yml
+openapi_spec_hash: 0752074b2a7b0534329a1e3176c94a62
 config_hash: aab05d0cf41f1f6b9f4d5677273c1600

api.md

@@ -512,7 +512,6 @@ Types:
 - <code><a href="./src/resources/payments.ts">Payment</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentCreateResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentRetryResponse</a></code>
-- <code><a href="./src/resources/payments.ts">PaymentReturnResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentSimulateActionResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentSimulateReceiptResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentSimulateReleaseResponse</a></code>
@@ -524,7 +523,7 @@ Methods:
 - <code title="get /v1/payments/{payment_token}">client.payments.<a href="./src/resources/payments.ts">retrieve</a>(paymentToken) -> Payment</code>
 - <code title="get /v1/payments">client.payments.<a href="./src/resources/payments.ts">list</a>({ ...params }) -> PaymentsCursorPage</code>
 - <code title="post /v1/payments/{payment_token}/retry">client.payments.<a href="./src/resources/payments.ts">retry</a>(paymentToken) -> PaymentRetryResponse</code>
-- <code title="post /v1/payments/{payment_token}/return">client.payments.<a href="./src/resources/payments.ts">return</a>(paymentToken, { ...params }) -> PaymentReturnResponse</code>
+- <code title="post /v1/payments/{payment_token}/return">client.payments.<a href="./src/resources/payments.ts">return</a>(paymentToken, { ...params }) -> Payment</code>
 - <code title="post /v1/simulate/payments/{payment_token}/action">client.payments.<a href="./src/resources/payments.ts">simulateAction</a>(paymentToken, { ...params }) -> PaymentSimulateActionResponse</code>
 - <code title="post /v1/simulate/payments/receipt">client.payments.<a href="./src/resources/payments.ts">simulateReceipt</a>({ ...params }) -> PaymentSimulateReceiptResponse</code>
 - <code title="post /v1/simulate/payments/release">client.payments.<a href="./src/resources/payments.ts">simulateRelease</a>({ ...params }) -> PaymentSimulateReleaseResponse</code>

src/index.ts

@@ -131,7 +131,6 @@ import {
   PaymentListParams,
   PaymentRetryResponse,
   PaymentReturnParams,
-  PaymentReturnResponse,
   PaymentSimulateActionParams,
   PaymentSimulateActionResponse,
   PaymentSimulateReceiptParams,
@@ -774,7 +773,6 @@ export declare namespace Lithic {
     type Payment as Payment,
     type PaymentCreateResponse as PaymentCreateResponse,
     type PaymentRetryResponse as PaymentRetryResponse,
-    type PaymentReturnResponse as PaymentReturnResponse,
     type PaymentSimulateActionResponse as PaymentSimulateActionResponse,
     type PaymentSimulateReceiptResponse as PaymentSimulateReceiptResponse,
     type PaymentSimulateReleaseResponse as PaymentSimulateReleaseResponse,

src/resources/financial-accounts/statements/statements.ts

@@ -174,6 +174,11 @@ export interface Statement {
    * Date when the next billing period will end
    */
   next_statement_end_date?: string;
+
+  /**
+   * Details on number and size of payments to pay off balance
+   */
+  payoff_details?: Statement.PayoffDetails | null;
 }
 
 export namespace Statement {
@@ -269,6 +274,40 @@ export namespace Statement {
 
     minimum_interest_charged?: number | null;
   }
+
+  /**
+   * Details on number and size of payments to pay off balance
+   */
+  export interface PayoffDetails {
+    /**
+     * The number of months it would take to pay off the balance in full by only paying
+     * the minimum payment. "NA" will signal negative or zero amortization
+     */
+    minimum_payment_months: string;
+
+    /**
+     * The sum of all interest and principal paid, in cents, when only paying minimum
+     * monthly payment. "NA" will signal negative or zero amortization
+     */
+    minimum_payment_total: string;
+
+    /**
+     * Number of months to full pay off
+     */
+    payoff_period_length_months: number;
+
+    /**
+     * The amount needed to be paid, in cents, each month in order to pay off current
+     * balance in the payoff period
+     */
+    payoff_period_monthly_payment_amount: number;
+
+    /**
+     * The sum of all interest and principal paid, in cents, when paying off in the
+     * payoff period
+     */
+    payoff_period_payment_total: number;
+  }
 }
 
 export interface Statements {

src/resources/index.ts

@@ -191,7 +191,6 @@ export {
   type Payment,
   type PaymentCreateResponse,
   type PaymentRetryResponse,
-  type PaymentReturnResponse,
   type PaymentSimulateActionResponse,
   type PaymentSimulateReceiptResponse,
   type PaymentSimulateReleaseResponse,

src/resources/payments.ts

@@ -101,7 +101,7 @@ export class Payments extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.payments.return(
+   * const payment = await client.payments.return(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *   {
    *     financial_account_token:
@@ -115,7 +115,7 @@ export class Payments extends APIResource {
     paymentToken: string,
     body: PaymentReturnParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<PaymentReturnResponse> {
+  ): Core.APIPromise<Payment> {
     return this._client.post(`/v1/payments/${paymentToken}/return`, { body, ...options });
   }
 
@@ -517,26 +517,6 @@ export interface PaymentRetryResponse extends Payment {
   balance?: BalancesAPI.Balance;
 }
 
-/**
- * Response from ACH operations including returns
- */
-export interface PaymentReturnResponse {
-  /**
-   * Transaction result
-   */
-  result: 'APPROVED' | 'DECLINED';
-
-  /**
-   * Globally unique identifier for the transaction group
-   */
-  transaction_group_uuid: string;
-
-  /**
-   * Globally unique identifier for the transaction
-   */
-  transaction_uuid: string;
-}
-
 export interface PaymentSimulateActionResponse {
   /**
    * Debugging Request Id
@@ -787,7 +767,6 @@ export declare namespace Payments {
     type Payment as Payment,
     type PaymentCreateResponse as PaymentCreateResponse,
     type PaymentRetryResponse as PaymentRetryResponse,
-    type PaymentReturnResponse as PaymentReturnResponse,
     type PaymentSimulateActionResponse as PaymentSimulateActionResponse,
     type PaymentSimulateReceiptResponse as PaymentSimulateReceiptResponse,
     type PaymentSimulateReleaseResponse as PaymentSimulateReleaseResponse,