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 ReceivedDebit might fail because the FinancialAccount doesn’t have sufficient funds, is closed, or is frozen.
Possible enum valuesaccount_
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_
accountnullable string The FinancialAccount that funds were pulled from.
- 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 how a ReceivedDebit was created.
- linked_
flowsobject Other flows linked to a ReceivedDebit.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - networkenum
The network used for the ReceivedDebit.
- reversal_
detailsnullable object Details describing when a ReceivedDebit might be reversed.
- statusenum
Status of the ReceivedDebit. ReceivedDebits are created with a status of either
succeeded
(approved) orfailed
(declined). The failure reason can be found under thefailure_
.code Possible enum valuesfailed
The ReceivedDebit was declined, and no Transaction was created.
succeeded
The ReceivedDebit was approved.
- transactionnullable stringExpandable
The Transaction associated with this object.
{ "id": "rd_1MtkUY2eZvKYlo2CT9SYD1AF", "object": "treasury.received_debit", "amount": 1000, "created": 1680755530, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MtkUY2eZvKYlo2CY3s6OQyK", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKMqWuaEGMgaYNwvP2Oc6NpPGJjaET9tspjuPmbhoXvIfQj6YrtJkjCiTFYe59B8Ck4cg5jTS80A9mLSaK_4oF_LBDlNzgg", "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": { "debit_reversal": null, "inbound_transfer": null, "issuing_authorization": null, "issuing_transaction": null, "payout": null }, "livemode": false, "network": "ach", "reversal_details": { "deadline": 1681084800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MtkUY2eZvKYlo2ChymLKPp5"}
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.
{ "id": "rd_1MtkUY2eZvKYlo2CT9SYD1AF", "object": "treasury.received_debit", "amount": 1000, "created": 1680755530, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MtkUY2eZvKYlo2CY3s6OQyK", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKMqWuaEGMgaYNwvP2Oc6NpPGJjaET9tspjuPmbhoXvIfQj6YrtJkjCiTFYe59B8Ck4cg5jTS80A9mLSaK_4oF_LBDlNzgg", "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": { "debit_reversal": null, "inbound_transfer": null, "issuing_authorization": null, "issuing_transaction": null, "payout": null }, "livemode": false, "network": "ach", "reversal_details": { "deadline": 1681084800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MtkUY2eZvKYlo2ChymLKPp5"}
Returns a list of ReceivedDebits.
Parameters
- financial_
accountstringRequired The FinancialAccount that funds were pulled from.
- statusenum
Only return ReceivedDebits that have the given status:
succeeded
orfailed
.Possible enum valuesfailed
The ReceivedDebit was declined, and no Transaction was created.
succeeded
The ReceivedDebit was approved.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
ReceivedDebits, starting after ReceivedDebit starting_
. Each entry in the array is a separate ReceivedDebit object. If no more ReceivedDebits are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/treasury/received_debits", "has_more": false, "data": [ { "id": "rd_1MtkUY2eZvKYlo2CT9SYD1AF", "object": "treasury.received_debit", "amount": 1000, "created": 1680755530, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MtkUY2eZvKYlo2CY3s6OQyK", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKMqWuaEGMgaYNwvP2Oc6NpPGJjaET9tspjuPmbhoXvIfQj6YrtJkjCiTFYe59B8Ck4cg5jTS80A9mLSaK_4oF_LBDlNzgg", "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": { "debit_reversal": null, "inbound_transfer": null, "issuing_authorization": null, "issuing_transaction": null, "payout": null }, "livemode": false, "network": "ach", "reversal_details": { "deadline": 1681084800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MtkUY2eZvKYlo2ChymLKPp5" } {...} {...} ],}
Test mode: Create a ReceivedDebit Test helper
Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits 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 pull funds from.
- 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 ReceivedDebit object.
{ "id": "rd_1MtkUY2eZvKYlo2CT9SYD1AF", "object": "treasury.received_debit", "amount": 1000, "created": 1680755530, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MtkUY2eZvKYlo2CY3s6OQyK", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKMqWuaEGMgaYNwvP2Oc6NpPGJjaET9tspjuPmbhoXvIfQj6YrtJkjCiTFYe59B8Ck4cg5jTS80A9mLSaK_4oF_LBDlNzgg", "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": { "debit_reversal": null, "inbound_transfer": null, "issuing_authorization": null, "issuing_transaction": null, "payout": null }, "livemode": false, "network": "ach", "reversal_details": { "deadline": 1681084800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MtkUY2eZvKYlo2ChymLKPp5"}
You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
You can reverse some ReceivedDebits depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
An active entitlement describes access to a feature for a customer.
If you have scheduled a Sigma query, you’ll receive a sigma.
webhook each time the query runs. The webhook contains a ScheduledQueryRun
object, which you can use to retrieve the query results.
The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.
Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.
The Report Type resource corresponds to a particular type of report, such as the “Activity summary” or “Itemized payouts” reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.
Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.
A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
Describes an owner of an account.
A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
A Transaction represents a real transaction that affects a Financial Connections Account balance.
A Tax Calculation allows you to calculate the tax to collect from your customer.
Related guide: Calculate tax in your custom payment flow
A Tax Registration
lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.
Stripe doesn’t register on your behalf with the relevant authorities when you create a Tax Registration
object. For more information on how to register to collect tax, see our guide.
Related guide: Using the Registrations API
A Tax Transaction records the tax collected from or refunded to your customer.
Related guide: Calculate tax in your custom payment flow
You can use Tax Settings
to manage configurations used by Stripe Tax calculations.
Related guide: Using the Settings API
A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.
A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.
Related guide: The Verification Sessions API
A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type
and options
parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document
, id_
, selfie
.
Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.
Related guide: Accessing verification results.
A Crypto Onramp Session represents your customer’s session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your user’s wallet and contain a reference to the crypto transaction ID.
You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.
Related guide: Integrate the onramp
Crypto Onramp Quotes are estimated quotes for onramp conversions into all the different cryptocurrencies on different networks. The Quotes API allows you to display quotes in your product UI before directing the user to the onramp widget.
Related guide: Quotes API
Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.
A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.
A supplier of carbon removal.
Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.
Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.
You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.
Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.
Related guide: Forward card details to third-party API endpoints.
You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.
Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.
Related guide: Setting up webhooks