expresspayments
Version:
ExpressPayments API wrapper
96 lines (82 loc) • 3.52 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'expresspayments' {
namespace ExpressPayments {
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://docs.epayments.network/currencies).
*/
currency: string;
/**
* The FinancialAccount to pull funds from.
*/
financial_account: string;
/**
* The rails used for the object.
*/
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;
}
}
}
}
namespace Treasury {
class ReceivedDebitsResource {
/**
* 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: ReceivedDebitCreateParams,
options?: RequestOptions
): Promise<
ExpressPayments.Response<
ExpressPayments.Treasury.ReceivedDebit
>
>;
}
}
}
}
}