Received Credits
ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
The ReceivedCredit object
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.
- 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.
- linked_
flowsobject Other flows linked to a ReceivedCredit.
- 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.
- reversal_
detailsnullable object Details describing when a ReceivedCredit may be reversed.
- 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_code
field. - transactionnullable stringExpandable
The Transaction associated with this object.
Retrieve a ReceivedCredit
Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
Parameters
No parameters.
Returns
Returns a ReceivedCredit object.
List all ReceivedCredits
Returns a list of ReceivedCredits.
Parameters
- financial_
accountstringRequired The FinancialAccount that received the funds.
- linked_
flowsobject Only return ReceivedCredits described by the flow.
- statusenum
Only return ReceivedCredits that have the given status:
succeeded
orfailed
.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
ReceivedCredits, starting after ReceivedCredit starting_after
. Each entry in the array is a separate ReceivedCredit object. If no more ReceivedCredits are available, the resulting array will be empty.
Test mode: Create a ReceivedCreditTest helper
Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.
Parameters
- amountintegerRequired
Amount (in cents) to be transferred.
- currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial_
accountstringRequired The FinancialAccount to send funds to.
- networkenumRequired
Specifies the network rails to be used. If not set, will default to the PaymentMethod’s preferred network. See the docs to learn more about money movement timelines for each network type.
- descriptionstring
An arbitrary string attached to the object. Often useful for displaying to users.
- initiating_
payment_ method_ detailsobject Initiating payment method details for the object.
Returns
A test mode ReceivedCredit object.