stripe
Version:
Stripe API wrapper
280 lines (230 loc) • 10.4 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
namespace Treasury {
/**
* ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
*/
interface ReceivedCredit {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'treasury.received_credit';
/**
* Amount (in cents) transferred.
*/
amount: number;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: 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;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description: string;
/**
* Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
*/
failure_code: ReceivedCredit.FailureCode | null;
/**
* The FinancialAccount that received the funds.
*/
financial_account: string | null;
/**
* A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
*/
hosted_regulatory_receipt_url: string | null;
initiating_payment_method_details: ReceivedCredit.InitiatingPaymentMethodDetails;
linked_flows: ReceivedCredit.LinkedFlows;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* The rails used to send the funds.
*/
network: ReceivedCredit.Network;
/**
* Details describing when a ReceivedCredit may be reversed.
*/
reversal_details: ReceivedCredit.ReversalDetails | null;
/**
* Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
*/
status: ReceivedCredit.Status;
/**
* The Transaction associated with this object.
*/
transaction: string | Stripe.Treasury.Transaction | null;
}
namespace ReceivedCredit {
type FailureCode =
| 'account_closed'
| 'account_frozen'
| 'international_transaction'
| 'other';
interface InitiatingPaymentMethodDetails {
/**
* Set when `type` is `balance`.
*/
balance?: 'payments';
billing_details: InitiatingPaymentMethodDetails.BillingDetails;
financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
/**
* Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
*/
issuing_card?: string;
/**
* Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
*/
type: InitiatingPaymentMethodDetails.Type;
us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
}
namespace InitiatingPaymentMethodDetails {
interface BillingDetails {
address: Stripe.Address;
/**
* Email address.
*/
email: string | null;
/**
* Full name.
*/
name: string | null;
}
interface FinancialAccount {
/**
* The FinancialAccount ID.
*/
id: string;
/**
* The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
*/
network: 'stripe';
}
type Type =
| 'balance'
| 'financial_account'
| 'issuing_card'
| 'stripe'
| 'us_bank_account';
interface UsBankAccount {
/**
* Bank name.
*/
bank_name: string | null;
/**
* The last four digits of the bank account number.
*/
last4: string | null;
/**
* The routing number for the bank account.
*/
routing_number: string | null;
}
}
interface LinkedFlows {
/**
* The CreditReversal created as a result of this ReceivedCredit being reversed.
*/
credit_reversal: string | null;
/**
* Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
*/
issuing_authorization: string | null;
/**
* Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.
*/
issuing_transaction: string | null;
/**
* ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
*/
source_flow: string | null;
/**
* The expandable object of the source flow.
*/
source_flow_details?: LinkedFlows.SourceFlowDetails | null;
/**
* The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
*/
source_flow_type: string | null;
}
namespace LinkedFlows {
interface SourceFlowDetails {
/**
* You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
*/
credit_reversal?: Stripe.Treasury.CreditReversal;
/**
* Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
*
* Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
*
* Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
*/
outbound_payment?: Stripe.Treasury.OutboundPayment;
/**
* Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
*
* Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
*
* Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
*/
outbound_transfer?: Stripe.Treasury.OutboundTransfer;
/**
* A `Payout` object is created when you receive funds from Stripe, or when you
* initiate a payout to either a bank account or debit card of a [connected
* Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
* and list all payouts. Payouts are made on [varying
* schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
* industry.
*
* Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
*/
payout?: Stripe.Payout;
/**
* The type of the source flow that originated the ReceivedCredit.
*/
type: SourceFlowDetails.Type;
}
namespace SourceFlowDetails {
type Type =
| 'credit_reversal'
| 'other'
| 'outbound_payment'
| 'outbound_transfer'
| 'payout';
}
}
type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
interface ReversalDetails {
/**
* Time before which a ReceivedCredit can be reversed.
*/
deadline: number | null;
/**
* Set if a ReceivedCredit cannot be reversed.
*/
restricted_reason: ReversalDetails.RestrictedReason | null;
}
namespace ReversalDetails {
type RestrictedReason =
| 'already_reversed'
| 'deadline_passed'
| 'network_restricted'
| 'other'
| 'source_flow_restricted';
}
type Status = 'failed' | 'succeeded';
}
}
}
}