72 lines
2.9 KiB
TypeScript
72 lines
2.9 KiB
TypeScript
import { StripeResource } from '../../../StripeResource.js';
|
|
import { ReceivedDebit } from './../../Treasury/ReceivedDebits.js';
|
|
import { RequestOptions, Response } from '../../../lib.js';
|
|
export declare class ReceivedDebitResource extends StripeResource {
|
|
/**
|
|
* Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
|
|
*/
|
|
create(params: TestHelpers.Treasury.ReceivedDebitCreateParams, options?: RequestOptions): Promise<Response<ReceivedDebit>>;
|
|
}
|
|
export declare namespace TestHelpers {
|
|
namespace Treasury {
|
|
interface ReceivedDebitCreateParams {
|
|
/**
|
|
* Amount (in cents) to be transferred.
|
|
*/
|
|
amount: number;
|
|
/**
|
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
*/
|
|
currency: string;
|
|
/**
|
|
* The FinancialAccount to pull funds from.
|
|
*/
|
|
financial_account: string;
|
|
/**
|
|
* Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
|
|
*/
|
|
network: 'ach';
|
|
/**
|
|
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
*/
|
|
description?: string;
|
|
/**
|
|
* Specifies which fields in the response should be expanded.
|
|
*/
|
|
expand?: Array<string>;
|
|
/**
|
|
* Initiating payment method details for the object.
|
|
*/
|
|
initiating_payment_method_details?: ReceivedDebitCreateParams.InitiatingPaymentMethodDetails;
|
|
}
|
|
namespace ReceivedDebitCreateParams {
|
|
interface InitiatingPaymentMethodDetails {
|
|
/**
|
|
* The source type.
|
|
*/
|
|
type: 'us_bank_account';
|
|
/**
|
|
* Optional fields for `us_bank_account`.
|
|
*/
|
|
us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
|
|
}
|
|
namespace InitiatingPaymentMethodDetails {
|
|
interface UsBankAccount {
|
|
/**
|
|
* The bank account holder's name.
|
|
*/
|
|
account_holder_name?: string;
|
|
/**
|
|
* The bank account number.
|
|
*/
|
|
account_number?: string;
|
|
/**
|
|
* The bank account's routing number.
|
|
*/
|
|
routing_number?: string;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|