Use ReceivedCredits API to retrieve information on when, where, and how funds are sent into your FinancialAccount.

Attributes

  • idstring

    Unique identifier for the ReceivedCredit.

  • objectstring, value is "v2.money_management.received_credit"

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

  • amountobject

    The amount and currency of the ReceivedCredit.

  • balance_transfernullable object

    This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if type field value is balance_transfer.

  • bank_transfernullable object

    This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if type field value is external_credit.

  • createdtimestamp

    Time at which the ReceivedCredit 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 set by originator of the ReceivedCredit.

  • financial_accountstring

    Financial Account ID on which funds for ReceivedCredit were received.

  • 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 hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

  • statusenum

    The status of the ReceivedCredit.

    Possible enum values
    failed

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

    pending

    The ReceivedCredit was successfully processed. However, the funds are not yet available for use. More details why it is pending can be obtained from status_details field.

    returned

    The ReceivedCredit was returned to the originator bank and the balance has been adjusted by deducting the original ReceivedCredit amount. More details why it was returned can be obtained from status_details field.

    succeeded

    The ReceivedCredit was successfully processed and balance reflects the received funds.

  • status_detailsnullable object

    This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as failed.

  • status_transitionsnullable object

    Hash containing timestamps of when the object transitioned to a particular status.

  • typeenum

    The type of flow that caused the ReceivedCredit.

    Possible enum values
    balance_transfer

    Funds received via internal Stripe balance transfer.

    bank_transfer

    Funds received as a bank transfer from external rails, such as ACH, Wire, RTP, etc.

    external_credit

    Replaced by BANK_TRANSFER, kept for backwards compatibility.

The ReceivedCredit object
{
"id": "rc_61O18kMR4G9BiyFkn16NsjVW2gfQu2lIgkGQVy6ueCx6",
"object": "v2.money_management.received_credit",
"financial_account": "fa_65NvHabRWMmVKVjernQ16NsjgsfdSQu2lIgkGQVy6ueDtY",
"amount": {
"value": 100,
"currency": "usd"
},
"description": "Weekly transfer 1",
"type": "bank_transfer",
"bank_transfer": {
"payment_method_type": "us_bank_account",
"statement_descriptor": "Fund Stripe account 05/12",
"us_bank_account": {
"last4": "4557",
"routing_number": "011000022",
"bank_name": "Goldman Sachs",
"network": "ach"
},
"financial_address": "finaddr_61NvHgGH9ksEFkYqj16NsjVW4dSQu2lIgkGQVy6ueWsx"
},
"status": "succeeded",
"status_details": null,
"created": "2023-05-12T16:27:02.086Z",
"receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk8wTVlLWjBTUURuM3A5OG9tZkQwWEEowNT4ogYyBvspfuDuEjpFlCZjXpjpVKRcHPK43kfFldwrwOO8ZPmRHjQmXL1jPf1GWWgoFxtL61dBWz-W2mEzwRgIgC0wPJi7M3HCUIOkSlwyfvHi",
"status_transitions": {
"succeeded_at": "2023-05-12T16:27:02.086Z",
"failed_at": null,
"returned_at": null
}
}

Retrieve a ReceivedCredit by ID.

Parameters

  • idstringRequired

    The ID of the ReceivedCredit to retrieve.

Returns

Response attributes

  • idstring

    Unique identifier for the ReceivedCredit.

  • objectstring, value is "v2.money_management.received_credit"

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

  • amountobject

    The amount and currency of the ReceivedCredit.

  • balance_transfernullable object

    This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if type field value is balance_transfer.

  • bank_transfernullable object

    This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if type field value is external_credit.

  • createdtimestamp

    Time at which the ReceivedCredit 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 set by originator of the ReceivedCredit.

  • financial_accountstring

    Financial Account ID on which funds for ReceivedCredit were received.

  • 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 hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

  • statusenum

    The status of the ReceivedCredit.

    Possible enum values
    failed

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

    pending

    The ReceivedCredit was successfully processed. However, the funds are not yet available for use. More details why it is pending can be obtained from status_details field.

    returned

    The ReceivedCredit was returned to the originator bank and the balance has been adjusted by deducting the original ReceivedCredit amount. More details why it was returned can be obtained from status_details field.

    succeeded

    The ReceivedCredit was successfully processed and balance reflects the received funds.

  • status_detailsnullable object

    This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as failed.

  • status_transitionsnullable object

    Hash containing timestamps of when the object transitioned to a particular status.

  • typeenum

    The type of flow that caused the ReceivedCredit.

    Possible enum values
    balance_transfer

    Funds received via internal Stripe balance transfer.

    bank_transfer

    Funds received as a bank transfer from external rails, such as ACH, Wire, RTP, etc.

    external_credit

    Replaced by BANK_TRANSFER, kept for backwards compatibility.

Error Codes
404not_found

The resource wasn’t found.

GET /v2/money_management/received_credits/:id
curl https://api.stripe.com/v2/money_management/received_credits/rc_61O18kMR4G9BiyFkn16NsjVW2gfQu2lIgkGQVy6ueCx6 \
-H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
-H "Stripe-Version: 2025-04-30.preview"
Response
{
"id": "rc_61O18kMR4G9BiyFkn16NsjVW2gfQu2lIgkGQVy6ueCx6",
"object": "v2.money_management.received_credit",
"financial_account": "fa_65NvHabRWMmVKVjernQ16NsjgsfdSQu2lIgkGQVy6ueDtY",
"amount": {
"value": 100,
"currency": "usd"
},
"description": "Weekly transfer 1",
"type": "bank_transfer",
"bank_transfer": {
"payment_method_type": "us_bank_account",
"statement_descriptor": "Fund Stripe account 05/12",
"us_bank_account": {
"last4": "4557",
"routing_number": "011000022",
"bank_name": "Goldman Sachs",
"network": "ach"
},
"financial_address": "finaddr_61NvHgGH9ksEFkYqj16NsjVW4dSQu2lIgkGQVy6ueWsx"
},
"status": "succeeded",
"status_details": null,
"created": "2023-05-12T16:27:02.086Z",
"receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk8wTVlLWjBTUURuM3A5OG9tZkQwWEEowNT4ogYyBvspfuDuEjpFlCZjXpjpVKRcHPK43kfFldwrwOO8ZPmRHjQmXL1jPf1GWWgoFxtL61dBWz-W2mEzwRgIgC0wPJi7M3HCUIOkSlwyfvHi",
"status_transitions": {
"succeeded_at": "2023-05-12T16:27:02.086Z",
"failed_at": null,
"returned_at": null
}
}

Retrieves a list of ReceivedCredits.

Parameters

  • createdtimestamp

    Filter for objects created at the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_gttimestamp

    Filter for objects created after the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_gtetimestamp

    Filter for objects created on or after the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_lttimestamp

    Filter for objects created before the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • created_ltetimestamp

    Filter for objects created on or before the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

  • limitinteger

    The page limit.

  • pagestring

    The page token.

Returns

Response attributes

  • dataarray of objects

    The retrieved ReceivedCredits.

  • next_page_urlnullable string

    The next page url.

  • previous_page_urlnullable string

    The previous page url.

Error Codes
404not_found

The resource wasn’t found.

GET /v2/money_management/received_credits
curl https://api.stripe.com/v2/money_management/received_credits \
-H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
-H "Stripe-Version: 2025-04-30.preview"
Response
{
"data": [
{
"id": "rc_61O18kMR4G9BiyFkn16NsjVW2gfQu2lIgkGQVy6ueCx6",
"object": "v2.money_management.received_credit",
"financial_account": "fa_65NvHabRWMmVKVjernQ16NsjgsfdSQu2lIgkGQVy6ueDtY",
"amount": {
"value": 100,
"currency": "usd"
},
"description": "Weekly transfer 1",
"type": "bank_transfer",
"bank_transfer": {
"payment_method_type": "us_bank_account",
"statement_descriptor": "Fund Stripe account 05/12",
"us_bank_account": {
"last4": "4557",
"routing_number": "011000022",
"bank_name": "Goldman Sachs",
"network": "ach"
},
"financial_address": "finaddr_61NvHgGH9ksEFkYqj16NsjVW4dSQu2lIgkGQVy6ueWsx"
},
"status": "succeeded",
"status_details": null,
"created": "2023-05-12T16:27:02.086Z",
"receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk8wTVlLWjBTUURuM3A5OG9tZkQwWEEowNT4ogYyBvspfuDuEjpFlCZjXpjpVKRcHPK43kfFldwrwOO8ZPmRHjQmXL1jPf1GWWgoFxtL61dBWz-W2mEzwRgIgC0wPJi7M3HCUIOkSlwyfvHi",
"status_transitions": {
"succeeded_at": "2023-05-12T16:27:02.086Z",
"failed_at": null,
"returned_at": null
}
},
{
"id": "rc_61NvJ0vCutkwhd9kv16NsjVW3dSQu2lIasGQVy6sdAEq",
"object": "v2.money_management.received_credit",
"financial_account": "fa_65NvHabRWMmVKVjernQ16NsjgsfdSQu2lIgkGQVy6ueDtY",
"amount": {
"value": 100000000,
"currency": "usd"
},
"description": "Weekly transfer 2",
"type": "bank_transfer",
"bank_transfer": {
"payment_method_type": "us_bank_account",
"statement_descriptor": "Fund Stripe account 05/09",
"us_bank_account": {
"last4": "4557",
"routing_number": "011000022",
"bank_name": "Goldman Sachs",
"network": "ach"
},
"financial_address": "finaddr_61NvHgGH9ksEFkYqj16NsjVW4dSQu2lIgkGQVy6ueWsx"
},
"status": "succeeded",
"status_details": null,
"created": "2023-05-09T16:27:02.086Z",
"receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk8wTVlLWjBTUURuM3A5OG9tZkQwWEEowNT4ogYyBiOaJJNGOjpFlA46et0qfvfYTzz0191oHra4Wpa5K80tLvWbiq3egozdIXbUTF95Ot0b5mwx6cf8iCmz28lFtP_Lo3X6MBS_B26m3aCj",
"status_transitions": {
"succeeded_at": "2023-05-09T16:27:02.086Z",
"failed_at": null,
"returned_at": null
}
}
],
"next_page_url": null,
"previous_page_url": null
}

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

Event types

Filter events by type

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_credit.available"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.available"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.available",
"changes": {},
"data": {
"transaction_id": "trxn_65SIg2l4L4cgf1QMQle13Ns7tI51SQD5CcHYMPnDCEaBfE"
}
}

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_credit.failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.failed"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.failed",
"changes": {},
"data": {}
}

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_credit.returned"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.returned"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.returned",
"changes": {},
"data": {}
}

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_credit.succeeded"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.succeeded"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.succeeded",
"changes": {},
"data": {}
}