The ReceivedCredit object

Attributes

• id string Unique identifier for the object.
• object string, value is "treasury.received_credit" String representing the object’s type. Objects of the same type share the same value.
• amount integer Amount (in cents) transferred.
• created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
• currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
• description string An arbitrary string attached to the object. Often useful for displaying to users.
• failure _ code nullable enum Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. Possible enum values account_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 _ account nullable string The FinancialAccount that received the funds.
• hosted _ regulatory _ receipt _ url nullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
• initiating _ payment _ method _ details object Details about the PaymentMethod used to send a ReceivedCredit.
• linked _ flows object Other flows linked to a ReceivedCredit.
• livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
• network enum The rails used to send the funds. Possible enum values ach card stripe us_domestic_wire
• reversal _ details nullable object Details describing when a ReceivedCredit may be reversed.
• status enum 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. Possible enum values failed The ReceivedCredit was declined, and no Transaction was created. succeeded The ReceivedCredit was approved.
• transaction nullable string Expandable The Transaction associated with this object.

The ReceivedCredit object

Retrieve a ReceivedCredit

GET / v1 / treasury / received_credits /:id

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.

Response

List all ReceivedCredits

GET / v1 / treasury / received_credits

Returns a list of ReceivedCredits.

Parameters

• financial _ account string The FinancialAccount that received the funds.
• linked _ flows object Only return ReceivedCredits described by the flow.
• status enum Only return ReceivedCredits that have the given status: succeeded or failed. Possible enum values failed The ReceivedCredit was declined, and no Transaction was created. succeeded The ReceivedCredit was approved.

More parameters

• ending _ before string
• limit integer
• starting _ after string

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.

Response