Received Debits v2

Learn more about calling API v2 endpoints.

Use ReceivedDebits API to retrieve information on when, where, and how funds are debited from your FinancialAccount.

Endpoints

GET/v2/money_management/received_debits/:id

GET/v2/money_management/received_debits

The ReceivedDebit object

Attributes

idstring
Unique identifier for the ReceivedDebit.

objectstring, value is "v2.money_management.received_debit"
String representing the object’s type. Objects of the same type share the same value of the object field.

amountobject
Amount and currency of the ReceivedDebit.

bank_transfernullable object
This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if type field value is bank_transfer.

createdtimestamp
The time at which the ReceivedDebit was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

descriptionnullable string
Freeform string sent by the originator of the ReceivedDebit.

financial_accountstring
Financial Account on which funds for ReceivedDebit were debited.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

receipt_urlnullable string
A link to the Stripe-hosted receipt for this ReceivedDebit.

statusenum

The status of the ReceivedDebit.

Possible enum values

canceled

The ReceivedDebit was canceled and the balance has been adjusted.

failed

The ReceivedDebit was rejected by Stripe and funds don’t change existing balance. More details why it failed can be obtained from status_details.

pending

The ReceivedDebit was successfully processed. However, the funds are not yet available for use.

returned

The ReceivedDebit was returned from the originator bank and the balance has been adjusted accordingly.

succeeded

The ReceivedDebit was successfully processed and balance reflects the withdrawn funds. Note that this is not a terminal state. The ReceivedDebit status may transition to returned even after succeeded.

status_detailsnullable object
Detailed information about the status of the ReceivedDebit.

status_transitionsnullable object
The time at which the ReceivedDebit transitioned to a particular status.

typeenum
The type of the ReceivedDebit.
Possible enum values
bank_transfer
The ReceivedDebit is the result of an bank transfer.
external_debit
Replaced by BANK_TRANSFER, kept for backwards compatibility. The ReceivedDebit is the result of an external debit.

The ReceivedDebit object

{
  "id": "rd_test_61PIoVqwBhv9ka9wC16PITSVZ3SQ2qpWK2k4kS9loWDo",
  "object": "v2.money_management.received_debit",
  "amount": {
    "value": 55,
    "currency": "usd"
  },
  "created": "2023-11-06T11:01:26.155Z",
  "description": "ACCTVERIFY",
  "external_debit": {
    "financial_address": "finaddr_test_61PIoViC3mXdq1lAw16PITSVZ3SQ2qpWK2k4kS9loTj6",
    "payment_method_type": "us_bank_account",
    "statement_descriptor": "ACCTVERIFY",
    "us_bank_account": {
      "bank_name": "",
      "network": "ach",
      "routing_number": "111000123"
    }
  },
  "financial_account": "fa_test_65PIoVY8QWjXEgwaibT16PITSVZ3SQ2qpWK2k4kS9loJCK",
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNlBJVFNWWjNTUTJxcFdLMms0a1M5bG8osJGjqgYyBlCBssNJPDpFlMRJIX8eJhbfPGVgqFw4oOmpp3COHbLKGzjRWAayQfKXUHSmoeS_VZTkCI9thg4KQHQUKGXSq5XRO06x44xrmFQCcRT6",
  "status": "succeeded",
  "status_details": null,
  "status_transitions": {
    "failed_at": null,
    "succeeded_at": "2023-11-06T11:01:26.155Z"
  },
  "type": "external_debit"
}

Retrieve a ReceivedDebit object v2

Learn more about calling API v2 endpoints.

Retrieves a single ReceivedDebit by ID.

Parameters

idstringRequired
The ID of the ReceivedDebit to retrieve.

Returns

Response attributes

idstring
Unique identifier for the ReceivedDebit.

objectstring, value is "v2.money_management.received_debit"
String representing the object’s type. Objects of the same type share the same value of the object field.

amountobject
Amount and currency of the ReceivedDebit.

bank_transfernullable object
This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if type field value is bank_transfer.

createdtimestamp
The time at which the ReceivedDebit was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

descriptionnullable string
Freeform string sent by the originator of the ReceivedDebit.

financial_accountstring
Financial Account on which funds for ReceivedDebit were debited.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

receipt_urlnullable string
A link to the Stripe-hosted receipt for this ReceivedDebit.

statusenum

The status of the ReceivedDebit.

Possible enum values

canceled

The ReceivedDebit was canceled and the balance has been adjusted.

failed

The ReceivedDebit was rejected by Stripe and funds don’t change existing balance. More details why it failed can be obtained from status_details.

pending

The ReceivedDebit was successfully processed. However, the funds are not yet available for use.

returned

The ReceivedDebit was returned from the originator bank and the balance has been adjusted accordingly.

succeeded

status_detailsnullable object
Detailed information about the status of the ReceivedDebit.

status_transitionsnullable object
The time at which the ReceivedDebit transitioned to a particular status.

typeenum
The type of the ReceivedDebit.
Possible enum values
bank_transfer
The ReceivedDebit is the result of an bank transfer.
external_debit
Replaced by BANK_TRANSFER, kept for backwards compatibility. The ReceivedDebit is the result of an external debit.

Error Codes

404not_found

The resource wasn’t found.

GET /v2/money_management/received_debits/:id

Server-side language

curl https://api.stripe.com/v2/money_management/received_debits/rd_test_61PIoVqwBhv9ka9wC16PITSVZ3SQ2qpWK2k4kS9loWDo \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview"

Response

{
  "id": "rd_test_61PIoVqwBhv9ka9wC16PITSVZ3SQ2qpWK2k4kS9loWDo",
  "object": "v2.money_management.received_debit",
  "amount": {
    "value": 55,
    "currency": "usd"
  },
  "created": "2023-11-06T11:01:26.155Z",
  "description": "ACCTVERIFY",
  "external_debit": {
    "financial_address": "finaddr_test_61PIoViC3mXdq1lAw16PITSVZ3SQ2qpWK2k4kS9loTj6",
    "payment_method_type": "us_bank_account",
    "statement_descriptor": "ACCTVERIFY",
    "us_bank_account": {
      "bank_name": "",
      "network": "ach",
      "routing_number": "111000123"
    }
  },
  "financial_account": "fa_test_65PIoVY8QWjXEgwaibT16PITSVZ3SQ2qpWK2k4kS9loJCK",
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNlBJVFNWWjNTUTJxcFdLMms0a1M5bG8osJGjqgYyBlCBssNJPDpFlMRJIX8eJhbfPGVgqFw4oOmpp3COHbLKGzjRWAayQfKXUHSmoeS_VZTkCI9thg4KQHQUKGXSq5XRO06x44xrmFQCcRT6",
  "status": "succeeded",
  "status_details": null,
  "status_transitions": {
    "failed_at": null,
    "succeeded_at": "2023-11-06T11:01:26.155Z"
  },
  "type": "external_debit"
}

List all ReceivedDebit objects v2

Learn more about calling API v2 endpoints.

Retrieves a list of ReceivedDebits, given the selected filters.

Parameters

limitinteger
The page limit.

pagestring
The page token.

Returns

Response attributes

dataarray of objects
The retrieved ReceivedDebits.

next_page_urlnullable string
The next page url.

previous_page_urlnullable string
The previous page url.

GET /v2/money_management/received_debits

Server-side language

curl https://api.stripe.com/v2/money_management/received_debits \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview"

Response

{
  "data": [
    {
      "id": "rd_test_61PIoVqwBhv9ka9wC16PITSVZ3SQ2qpWK2k4kS9loWDo",
      "object": "v2.money_management.received_debit",
      "amount": {
        "value": 55,
        "currency": "usd"
      },
      "created": "2023-11-06T11:01:26.155Z",
      "description": "ACCTVERIFY",
      "external_debit": {
        "financial_address": "finaddr_test_61PIoViC3mXdq1lAw16PITSVZ3SQ2qpWK2k4kS9loTj6",
        "payment_method_type": "us_bank_account",
        "statement_descriptor": "ACCTVERIFY",
        "us_bank_account": {
          "bank_name": "",
          "network": "ach",
          "routing_number": "111000123"
        }
      },
      "financial_account": "fa_test_65PIoVY8QWjXEgwaibT16PITSVZ3SQ2qpWK2k4kS9loJCK",
      "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNlBJVFNWWjNTUTJxcFdLMms0a1M5bG8o-5CjqgYyBpSiNl2FdDpFlHfRZ5aHTmKqCIlJoG1eu5-2rKOgobcjIGeYgU0QZtZwAanr_6Q_NFssjur4JAGk0YwgBgi9FwzPenc5_eYHxa6q8IaH",
      "status": "succeeded",
      "status_details": null,
      "status_transitions": {
        "failed_at": null,
        "succeeded_at": "2023-11-06T11:01:26.155Z"
      },
      "type": "external_debit"
    }
  ],
  "next_page_url": "0X41451dLDMbApu3Gs3UY6gR7kb7gi6L83Hc4tD5kv7wQ6xK3p56TR7wR3HC5LV5cB5kY3Pv5PG7YO5oR3MB3UR5Xd7Dj5oK7P60DK0sT3bt3oA3bs3Tc3bl3Xh",
  "previous_page_url": null
}

ReceivedDebit event types v2

Learn more about calling API v2 endpoints.

This is a list of all public thin events we currently send for updates to ReceivedDebit, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

v2.money_management.received_debit.canceled

Occurs when a ReceivedDebit is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.received_debit.canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.received_debit.failed

Occurs when a ReceivedDebit fails.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.received_debit.failed"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.received_debit.pending

Occurs when a ReceivedDebit is set to pending.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.received_debit.pending"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.received_debit.succeeded

Occurs when a ReceivedDebit succeeds.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.received_debit.succeeded"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.received_debit.updated

Occurs when a ReceivedDebit is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.received_debit.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Received Debits v2

The ReceivedDebit object

Attributes

idstring

objectstring, value is "v2.money_management.received_debit"

amountobject

bank_transfernullable object

createdtimestamp

descriptionnullable string

financial_accountstring

livemodeboolean

receipt_urlnullable string

statusenum

status_detailsnullable object

status_transitionsnullable object

typeenum

Retrieve a ReceivedDebit object v2

Parameters

idstringRequired

Returns

Response attributes

idstring

objectstring, value is "v2.money_management.received_debit"

amountobject

bank_transfernullable object

createdtimestamp

descriptionnullable string

financial_accountstring

livemodeboolean

receipt_urlnullable string

statusenum

status_detailsnullable object

status_transitionsnullable object

typeenum

List all ReceivedDebit objects v2

Parameters

limitinteger

pagestring

Returns

Response attributes

dataarray of objects

next_page_urlnullable string

previous_page_urlnullable string

ReceivedDebit event types v2

Event types

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.money_management.received_debit.canceled"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.money_management.received_debit.failed"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.money_management.received_debit.pending"

Fetched attributes

dataobject

Attributes

idstring