The ReceivedDebit object

Attributes

• id string Unique identifier for the object.
• object string, value is "treasury.received_debit" 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 ReceivedDebit might fail because the FinancialAccount doesn’t have sufficient funds, is closed, or is frozen. Possible enum values account_closed Funds can’t be pulled from a closed FinancialAccount. account_frozen Funds can’t be pulled from a frozen FinancialAccount. insufficient_funds The FinancialAccount doesn’t have a sufficient balance. international_transaction International transactions can’t pull funds from the FinancialAccount. other Funds can’t be pulled from the FinancialAccount for other reasons.
• financial _ account nullable string The FinancialAccount that funds were pulled from.
• 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 how a ReceivedDebit was created.
• linked _ flows object Other flows linked to a ReceivedDebit.
• 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 network used for the ReceivedDebit.
• reversal _ details nullable object Details describing when a ReceivedDebit might be reversed.
• status enum Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code. Possible enum values failed The ReceivedDebit was declined, and no Transaction was created. succeeded The ReceivedDebit was approved.
• transaction nullable string Expandable The Transaction associated with this object.

The ReceivedDebit object

Retrieve a ReceivedDebit

GET / v1 / treasury / received_debits /:id

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

Parameters

No parameters.

Returns

Returns a ReceivedDebit object.

Response

List all ReceivedDebits

GET / v1 / treasury / received_debits

Returns a list of ReceivedDebits.

Parameters

• financial _ account string The FinancialAccount that funds were pulled from.
• status enum Only return ReceivedDebits that have the given status: succeeded or failed. Possible enum values failed The ReceivedDebit was declined, and no Transaction was created. succeeded The ReceivedDebit 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 ReceivedDebits, starting after ReceivedDebit starting_after. Each entry in the array is a separate ReceivedDebit object. If no more ReceivedDebits are available, the resulting array will be empty.

Response