Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- amountinteger
Amount (in cents) transferred.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionstring
An arbitrary string attached to the object. Often useful for displaying to users.
- failure_
codenullable enum Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
Possible enum valuesaccount_
closed Funds can’t be sent to a closed FinancialAccount.
account_
frozen Funds can’t be sent to a frozen FinancialAccount.
international_
transaction International transactions can’t be sent to FinancialAccount.
other
Funds can’t be sent to FinancialAccount for other reasons.
- financial_
accountnullable string The FinancialAccount that received the funds.
- hosted_
regulatory_ receipt_ urlnullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
- initiating_
payment_ method_ detailsobject Details about the PaymentMethod used to send a ReceivedCredit.
- initiating_payment_method_details.
balancenullable enum Set when
type
isbalance
.Possible enum valuespayments
The Stripe payments balance.
- initiating_payment_method_details.
billing_ detailsobject The contact details of the person or business referenced by the received payment method details.
- initiating_payment_method_details.
billing_details. addressobject Billing address.
- initiating_payment_method_details.
billing_details. address. citynullable string City, district, suburb, town, or village.
- initiating_payment_method_details.
billing_details. address. countrynullable string Two-letter country code (ISO 3166-1 alpha-2).
- initiating_payment_method_details.
billing_details. address. line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- initiating_payment_method_details.
billing_details. address. line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- initiating_payment_method_details.
billing_details. address. postal_ codenullable string ZIP or postal code.
- initiating_payment_method_details.
billing_details. address. statenullable string State, county, province, or region.
- initiating_payment_method_details.
billing_details. emailnullable string Email address.
- initiating_payment_method_details.
billing_details. namenullable string Full name.
- initiating_payment_method_details.
financial_ accountnullable object Set when
type
isfinancial_
. This is a FinancialAccount ID.account - initiating_payment_method_details.
financial_account. idstring The FinancialAccount ID.
- initiating_payment_method_details.
financial_account. networkenum The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over
stripe
.
- initiating_payment_method_details.
issuing_ cardnullable string Set when
type
isissuing_
. This is an Issuing Card ID.card - initiating_payment_method_details.
typeenum Polymorphic type matching the originating money movement’s source. This can be an external account, a Stripe balance, or a FinancialAccount.
- initiating_payment_method_details.
us_ bank_ accountnullable object Set when
type
isus_
.bank_ account - initiating_payment_method_details.
us_bank_account. bank_ namenullable string Bank name.
- initiating_payment_method_details.
us_bank_account. last4nullable string The last four digits of the bank account number.
- initiating_payment_method_details.
us_bank_account. routing_ numbernullable string The routing number for the bank account.
- linked_
flowsobject Other flows linked to a ReceivedCredit.
- linked_flows.
credit_ reversalnullable string The CreditReversal created as a result of this ReceivedCredit being reversed.
- linked_flows.
nullable string Set if the ReceivedCredit was created due to an Issuing Authorization object.
- linked_flows.
issuing_ transactionnullable string Set if the ReceivedCredit is also viewable as an Issuing transaction object.
- linked_flows.
source_ flownullable string ID of the source flow. Set if
network
isstripe
and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. - linked_flows.
source_ flow_ detailsnullable objectExpandable The expandable object of the source flow.
- linked_flows.
source_flow_details. credit_ reversalnullable object Details about a CreditReversal.
- linked_flows.
source_flow_details. credit_reversal. idstring Unique identifier for the object.
- linked_flows.
source_flow_details. credit_reversal. objectstring String representing the object’s type. Objects of the same type share the same value.
- linked_flows.
source_flow_details. credit_reversal. amountinteger Amount (in cents) transferred.
- linked_flows.
source_flow_details. credit_reversal. createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- linked_flows.
source_flow_details. credit_reversal. currencyenum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- linked_flows.
source_flow_details. credit_reversal. financial_ accountstring The FinancialAccount to reverse funds from.
- linked_flows.
source_flow_details. credit_reversal. hosted_ regulatory_ receipt_ urlnullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
- linked_flows.
source_flow_details. credit_reversal. livemodeboolean Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - linked_flows.
source_flow_details. credit_reversal. metadataobject Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- linked_flows.
source_flow_details. credit_reversal. networkenum The rails used to reverse the funds.
- linked_flows.
source_flow_details. credit_reversal. received_ creditstring The ReceivedCredit being reversed.
- linked_flows.
source_flow_details. credit_reversal. statusenum Status of the CreditReversal
Possible enum valuescanceled
The CreditReversal has been canceled before it has been sent to the network and no funds have left the account. (Currently not supported).
posted
The CreditReversal has been sent to the network and funds have left the account (with the Transaction posting)
processing
The CreditReversal starting state. Funds are “held” by a pending Transaction (but they are still part of the current balance).
- linked_flows.
source_flow_details. credit_reversal. status_ transitionsobject Hash containing timestamps of when the object transitioned to a particular
status
.- linked_flows.
source_flow_details. credit_reversal. status_transitions. posted_ atnullable timestamp Timestamp describing when the CreditReversal changed status to
posted
- linked_flows.
source_flow_details. credit_reversal. transactionnullable stringExpandable The Transaction associated with this object.
- linked_flows.
source_flow_details. outbound_ paymentnullable object Details about an OutboundPayment.
- linked_flows.
source_flow_details. outbound_payment. idstring Unique identifier for the object.
- linked_flows.
source_flow_details. outbound_payment. objectstring String representing the object’s type. Objects of the same type share the same value.
- linked_flows.
source_flow_details. outbound_payment. amountinteger Amount (in cents) transferred.
- linked_flows.
source_flow_details. outbound_payment. cancelableboolean Returns
true
if the object can be canceled, andfalse
otherwise. - linked_flows.
source_flow_details. outbound_payment. createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- linked_flows.
source_flow_details. outbound_payment. currencyenum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- linked_flows.
source_flow_details. outbound_payment. customernullable string ID of the customer to whom an OutboundPayment is sent.
- linked_flows.
source_flow_details. outbound_payment. descriptionnullable string An arbitrary string attached to the object. Often useful for displaying to users.
- linked_flows.
source_flow_details. outbound_payment. destination_ payment_ methodnullable string The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using
destination_
.payment_ method_ data - linked_flows.
source_flow_details. outbound_payment. destination_ payment_ method_ detailsnullable object Details about the PaymentMethod for an OutboundPayment.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_ detailsobject Contact details for the person or business receiving the OutboundPayment.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. addressobject Billing address.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. address. citynullable string City, district, suburb, town, or village.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. address. countrynullable string Two-letter country code (ISO 3166-1 alpha-2).
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. address. line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. address. line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. address. postal_ codenullable string ZIP or postal code.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. address. statenullable string State, county, province, or region.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. emailnullable string Email address.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. billing_details. namenullable string Full name.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. financial_ accountnullable object Details about the
financial_
.account - linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. financial_account. idstring Token of the FinancialAccount.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. financial_account. networkenum The rails used to send funds.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. typeenum The type of the payment method used in the OutboundPayment.
Possible enum valuesfinancial_
account us_
bank_ account - linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_ bank_ accountnullable object Details about the
us_
.bank_ account - linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. account_ holder_ typenullable enum Account holder type: individual or company.
Possible enum valuescompany
Account belongs to a company
individual
Account belongs to an individual
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. account_ typenullable enum Account type: checkings or savings. Defaults to checking if omitted.
Possible enum valueschecking
Bank account type is checking
savings
Bank account type is savings
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. bank_ namenullable string Name of the bank associated with the bank account.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. fingerprintnullable string Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. last4nullable string Last four digits of the bank account number.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. mandatenullable stringExpandable ID of the mandate used to make this payment.
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. networkenum The network rails used. See the docs to learn more about money movement timelines for each network type.
Possible enum valuesach
ACH network
us_
domestic_ wire US domestic wire network
- linked_flows.
source_flow_details. outbound_payment. destination_payment_method_details. us_bank_account. routing_ numbernullable string Routing number of the bank account.
- linked_flows.
source_flow_details. outbound_payment. end_ user_ detailsnullable object Details about the end user.
- linked_flows.
source_flow_details. outbound_payment. end_user_details. ip_ addressnullable string IP address of the user initiating the OutboundPayment. Set if
present
is set totrue
. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. - linked_flows.
source_flow_details. outbound_payment. end_user_details. presentboolean true
if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise,false
.
- linked_flows.
source_flow_details. outbound_payment. expected_ arrival_ datetimestamp The date when funds are expected to arrive in the destination account.
- linked_flows.
source_flow_details. outbound_payment. financial_ accountstring The FinancialAccount that funds were pulled from.
- linked_flows.
source_flow_details. outbound_payment. hosted_ regulatory_ receipt_ urlnullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
- linked_flows.
source_flow_details. outbound_payment. livemodeboolean Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - linked_flows.
source_flow_details. outbound_payment. metadataobject Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- linked_flows.
source_flow_details. outbound_payment. returned_ detailsnullable object Details about a returned OutboundPayment. Only set when the status is
returned
.- linked_flows.
source_flow_details. outbound_payment. returned_details. codeenum Reason for the return.
Possible enum valuesaccount_
closed The destination has been closed.
account_
frozen The destination has been frozen.
bank_
account_ restricted The destination bank account has restrictions on either the type or number of transfers allowed. This normally indicates that the bank account is a savings or other non-checking account.
bank_
ownership_ changed The destination bank account is no longer valid because its branch has changed ownership.
declined
The destination has declined this OutboundPayment.
incorrect_
account_ holder_ name The destination bank notified us that the bank account holder name on file is incorrect.
invalid_
account_ number The destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.
invalid_
currency The destination was unable to process this OutboundPayment because of its currency.
no_
account The destination bank account details on file are probably incorrect. No bank account exists with these details.
other
The destination could not process this OutboundPayment.
- linked_flows.
source_flow_details. outbound_payment. returned_details. transactionstringExpandable The Transaction associated with this object.
- linked_flows.
source_flow_details. outbound_payment. statement_ descriptorstring The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
- linked_flows.
source_flow_details. outbound_payment. statusenum Current status of the OutboundPayment:
processing
,failed
,posted
,returned
,canceled
. An OutboundPayment isprocessing
if it has been created and is pending. The status changes toposted
once the OutboundPayment has been “confirmed” and funds have left the account, or tofailed
orcanceled
. If an OutboundPayment fails to arrive at its destination, its status will change toreturned
. - linked_flows.
source_flow_details. outbound_payment. status_ transitionsobject Hash containing timestamps of when the object transitioned to a particular
status
.- linked_flows.
source_flow_details. outbound_payment. status_transitions. canceled_ atnullable timestamp Timestamp describing when an OutboundPayment changed status to
canceled
. - linked_flows.
source_flow_details. outbound_payment. status_transitions. failed_ atnullable timestamp Timestamp describing when an OutboundPayment changed status to
failed
. - linked_flows.
source_flow_details. outbound_payment. status_transitions. posted_ atnullable timestamp Timestamp describing when an OutboundPayment changed status to
posted
. - linked_flows.
source_flow_details. outbound_payment. status_transitions. returned_ atnullable timestamp Timestamp describing when an OutboundPayment changed status to
returned
.
- linked_flows.
source_flow_details. outbound_payment. tracking_ detailsnullable object Details about network-specific tracking information if available.
- linked_flows.
source_flow_details. outbound_payment. tracking_details. achnullable object ACH network tracking details.
- linked_flows.
source_flow_details. outbound_payment. tracking_details. ach. trace_ idstring ACH trace ID of the OutboundPayment for payments sent over the
ach
network.
- linked_flows.
source_flow_details. outbound_payment. tracking_details. typeenum The US bank account network used to send funds.
Possible enum valuesach
us_
domestic_ wire - linked_flows.
source_flow_details. outbound_payment. tracking_details. us_ domestic_ wirenullable object US domestic wire network tracking details.
- linked_flows.
source_flow_details. outbound_payment. tracking_details. us_domestic_wire. chipsnullable string CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the
us_
network.domestic_ wire - linked_flows.
source_flow_details. outbound_payment. tracking_details. us_domestic_wire. imadnullable string IMAD of the OutboundPayment for payments sent over the
us_
network.domestic_ wire - linked_flows.
source_flow_details. outbound_payment. tracking_details. us_domestic_wire. omadnullable string OMAD of the OutboundPayment for payments sent over the
us_
network.domestic_ wire
- linked_flows.
source_flow_details. outbound_payment. transactionstringExpandable The Transaction associated with this object.
- linked_flows.
source_flow_details. payoutnullable object Details about a Payout.
- linked_flows.
source_flow_details. payout. idstring Unique identifier for the object.
- linked_flows.
source_flow_details. payout. objectstring String representing the object’s type. Objects of the same type share the same value.
- linked_flows.
source_flow_details. payout. amountinteger The amount (in cents) that transfers to your bank account or debit card.
- linked_flows.
source_flow_details. payout. application_ feenullable stringExpandableConnect only The application fee (if any) for the payout. See the Connect documentation for details.
- linked_flows.
source_flow_details. payout. application_ fee_ amountnullable integerConnect only The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.
- linked_flows.
source_flow_details. payout. arrival_ datetimestamp Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
- linked_flows.
source_flow_details. payout. automaticboolean Returns
true
if the payout is created by an automated payout schedule andfalse
if it’s requested manually. - linked_flows.
source_flow_details. payout. balance_ transactionnullable stringExpandable ID of the balance transaction that describes the impact of this payout on your account balance.
- linked_flows.
source_flow_details. payout. createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- linked_flows.
source_flow_details. payout. currencyenum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- linked_flows.
source_flow_details. payout. descriptionnullable string An arbitrary string attached to the object. Often useful for displaying to users.
- linked_flows.
source_flow_details. payout. destinationnullable stringExpandable ID of the bank account or card the payout is sent to.
- linked_flows.
source_flow_details. payout. failure_ balance_ transactionnullable stringExpandable If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
- linked_flows.
source_flow_details. payout. failure_ codenullable string Error code that provides a reason for a payout failure, if available. View our list of failure codes.
- linked_flows.
source_flow_details. payout. failure_ messagenullable string Message that provides the reason for a payout failure, if available.
- linked_flows.
source_flow_details. payout. livemodeboolean Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - linked_flows.
source_flow_details. payout. metadatanullable object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- linked_flows.
source_flow_details. payout. methodstring The method used to send this payout, which can be
standard
orinstant
.instant
is supported for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts. - linked_flows.
source_flow_details. payout. original_ payoutnullable stringExpandable If the payout reverses another, this is the ID of the original payout.
- linked_flows.
source_flow_details. payout. reconciliation_ statusenum If
completed
, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.Possible enum valuescompleted
The Balance Transactions paid out in this payout. You can query it with the Balance Transactions API.
in_
progress You can query the Balance Transactions paid out in this payout soon.
not_
applicable We don’t support listing Balance Transactions for this payout. We only support this for standard automatic payouts.
- linked_flows.
source_flow_details. payout. reversed_ bynullable stringExpandable If the payout reverses, this is the ID of the payout that reverses this payout.
- linked_flows.
source_flow_details. payout. source_ typestring The source balance this payout came from, which can be one of the following:
card
,fpx
, orbank_
.account - linked_flows.
source_flow_details. payout. statement_ descriptornullable string Extra information about a payout that displays on the user’s bank statement.
- linked_flows.
source_flow_details. payout. statusstring Current status of the payout:
paid
,pending
,in_
,transit canceled
orfailed
. A payout ispending
until it’s submitted to the bank, when it becomesin_
. The status changes totransit paid
if the transaction succeeds, or tofailed
orcanceled
(within 5 business days). Some payouts that fail might initially show aspaid
, then change tofailed
. - linked_flows.
source_flow_details. payout. typeenum Can be
bank_
oraccount card
.
- linked_flows.
source_flow_details. typeenum The type of the source flow that originated the ReceivedCredit.
Possible enum valuescredit_
reversal ReceivedCredits that were reversed and have associated CreditReversals.
other
ReceivedCredits created from other source flow.
outbound_
payment ReceivedCredits created from OutboundPayments.
payout
ReceivedCredits created from Payouts.
- linked_flows.
source_ flow_ typenullable string The type of flow that originated the ReceivedCredit (for example,
outbound_
).payment
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - networkenum
The rails used to send the funds.
Possible enum valuesach
card
stripe
us_
domestic_ wire - reversal_
detailsnullable object Details describing when a ReceivedCredit may be reversed.
- reversal_details.
deadlinenullable timestamp Time before which a ReceivedCredit can be reversed.
- reversal_details.
restricted_ reasonnullable enum Set if a ReceivedCredit cannot be reversed.
Possible enum valuesalready_
reversed A ReceivedCredit that’s already reversed has this
restricted_
. It may have a deadline populated in some cases.reason deadline_
passed A ReceivedCredit which used to be reversible until the timestamp in
deadline
, but is no longer reversible. ACH ReceivedCredits are only reversible for some time after they’re created.network_
restricted Network constraints prevent Stripe from allowing reversal on some ReceivedCredits, such as a ReceivedCredit from a wire transfer.
other
A ReceivedCredit that was reversed because of another reason.
source_
flow_ restricted Stripe restricts users from reversing a Stripe network ReceivedCredit.
- statusenum
Status of the ReceivedCredit. ReceivedCredits are created either
succeeded
(approved) orfailed
(declined). If a ReceivedCredit is declined, the failure reason can be found in thefailure_
field.code Possible enum valuesfailed
The ReceivedCredit was declined, and no Transaction was created.
succeeded
The ReceivedCredit was approved.
- transactionnullable stringExpandable
The Transaction associated with this object.
{ "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw", "object": "treasury.received_credit", "amount": 1000, "created": 1680755425, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw", "initiating_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "routing_number": "110000000" } }, "linked_flows": { "credit_reversal": null, "issuing_authorization": null, "issuing_transaction": null, "source_flow": null, "source_flow_type": null }, "livemode": false, "network": "ach", "reversal_details": { "deadline": 1681084800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0"}