stripe
Version:
Stripe API wrapper
262 lines (261 loc) • 12.2 kB
TypeScript
import { StripeResource } from '../../StripeResource.js';
import { Transaction } from './Transactions.js';
import { CreditReversal } from './CreditReversals.js';
import { OutboundPayment } from './OutboundPayments.js';
import { OutboundTransfer } from './OutboundTransfers.js';
import { Payout } from './../Payouts.js';
import { PaginationParams, Address } from '../../shared.js';
import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
export declare class ReceivedCreditResource extends StripeResource {
/**
* Returns a list of ReceivedCredits.
*/
list(params: Treasury.ReceivedCreditListParams, options?: RequestOptions): ApiListPromise<ReceivedCredit>;
/**
* Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
*/
retrieve(id: string, params?: Treasury.ReceivedCreditRetrieveParams, options?: RequestOptions): Promise<Response<ReceivedCredit>>;
}
export 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: Treasury.ReceivedCredit.FailureCode | null;
/**
* The FinancialAccount that received the funds.
*/
financial_account: string | null;
/**
* A [hosted transaction receipt](https://docs.stripe.com/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: Treasury.ReceivedCredit.InitiatingPaymentMethodDetails;
linked_flows: Treasury.ReceivedCredit.LinkedFlows;
/**
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
*/
livemode: boolean;
/**
* The rails used to send the funds.
*/
network: Treasury.ReceivedCredit.Network;
/**
* Details describing when a ReceivedCredit may be reversed.
*/
reversal_details: Treasury.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: Treasury.ReceivedCredit.Status;
/**
* The Transaction associated with this object.
*/
transaction: string | Transaction | null;
}
export declare namespace Treasury {
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://api.stripe.com#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;
}
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://api.stripe.com#issuing_authorizations) object.
*/
issuing_authorization: string | null;
/**
* Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#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;
}
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;
}
type Status = 'failed' | 'succeeded';
namespace InitiatingPaymentMethodDetails {
interface BillingDetails {
address: 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;
}
}
namespace LinkedFlows {
interface SourceFlowDetails {
/**
* You can reverse some [ReceivedCredits](https://api.stripe.com#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?: 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://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#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?: OutboundPayment;
/**
* Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#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?: 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://docs.stripe.com/payouts)
*/
payout?: 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';
}
}
namespace ReversalDetails {
type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
}
}
}
export declare namespace Treasury {
interface ReceivedCreditRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
}
export declare namespace Treasury {
interface ReceivedCreditListParams extends PaginationParams {
/**
* The FinancialAccount that received the funds.
*/
financial_account: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Only return ReceivedCredits described by the flow.
*/
linked_flows?: ReceivedCreditListParams.LinkedFlows;
/**
* Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
*/
status?: ReceivedCreditListParams.Status;
}
namespace ReceivedCreditListParams {
interface LinkedFlows {
/**
* The source flow type.
*/
source_flow_type: LinkedFlows.SourceFlowType;
}
type Status = 'failed' | 'succeeded';
namespace LinkedFlows {
type SourceFlowType = 'credit_reversal' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'payout';
}
}
}