Test mode: Create a ReceivedDebit

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.

post/v1/test_helpers/treasury/received_debits

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

descriptionstring required

An arbitrary string attached to the object. Often useful for displaying to users.

failure_code'account_closed' | 'account_frozen' | 'insufficient_funds' | 'international_transaction' | 'other' nullable

Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.

financial_accountstring nullable

The FinancialAccount that funds were pulled from.

hosted_regulatory_receipt_urlstring nullable

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

network'ach' | 'card' | 'stripe' required

The network used for the ReceivedDebit.

object'treasury.received_debit' required

String representing the object's type. Objects of the same type share the same value.

status'failed' | 'succeeded' required

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.

Changes

Changed in 9 of the 51 revisions of this API.161624

Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property /////////////// became optional for the status
  response-property-became-optional
- ▲
  the response property //////////// became optional for the status
  response-property-became-optional
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Dec 14, 202446de5407335916See the full diff
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2024d8ab202758612See the full diff
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Oct 23, 202433103c93fb8c14See the full diff
- ▲
  the ///////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////// response's property type changed from no type to object for status
  response-property-type-changed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history