# The ReceivedCredit object

## Attributes

- `id` (string)
  Unique identifier for the ReceivedCredit.

- `object` (string, 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.

- `amount` (object)
  The amount and currency of the ReceivedCredit.

  - `amount.currency` (string)
    A lowercase alpha3 currency code like “usd”.

  - `amount.value` (integer)
    In minor units like 123 for 1.23 USD.

- `balance_transfer` (object, nullable)
  This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if `type` field value is `balance_transfer`.

  - `balance_transfer.payout_v1` (string)
    The ID of the Stripe Money Movement that originated the ReceivedCredit.

  - `balance_transfer.type` (enum)
    The type of Stripe Money Movement that originated the ReceivedCredit.
Possible enum values:
    - `payout_v1`
      Balance transfer initiated by v1 payouts request.

- `bank_transfer` (object, nullable)
  This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if `type` field value is `external_credit`.

  - `bank_transfer.financial_address` (string)
    Financial Address on which funds for ReceivedCredit were received.

  - `bank_transfer.gb_bank_account` (object, nullable)
    Hash containing the transaction bank details. Present if `payment_method_type` field value is `gb_bank_account`.

    - `bank_transfer.gb_bank_account.account_holder_name` (string, nullable)
      The bank name the transfer was received from.

    - `bank_transfer.gb_bank_account.bank_name` (string, nullable)
      The bank name the transfer was received from.

    - `bank_transfer.gb_bank_account.last4` (string, nullable)
      The last 4 digits of the account number that originated the transfer.

    - `bank_transfer.gb_bank_account.network` (enum)
      The money transmission network used to send funds for this ReceivedCredit.
Possible enum values:
      - `fps`
        Funds received via FPS (Faster Payment System) network.

    - `bank_transfer.gb_bank_account.sort_code` (string, nullable)
      The sort code of the account that originated the transfer.

  - `bank_transfer.payment_method_type` (enum)
    Indicates the type of source via from which external funds originated.
Possible enum values:
    - `gb_bank_account`
      Funds received from a UK based bank account. See more details in the field “gb_bank_account”.

    - `us_bank_account`
      Funds received from a U.S. based bank account. See more details in the field “us_bank_account”.

  - `bank_transfer.statement_descriptor` (string, nullable)
    Freeform string set by originator of the external ReceivedCredit.

  - `bank_transfer.us_bank_account` (object, nullable)
    Hash containing the transaction bank details. Present if `payment_method_type` field value is `us_bank_account`.

    - `bank_transfer.us_bank_account.bank_name` (string, nullable)
      The bank name the transfer was received from.

    - `bank_transfer.us_bank_account.last4` (string, nullable)
      The last 4 digits of the account number that originated the transfer.

    - `bank_transfer.us_bank_account.network` (enum)
      The money transmission network used to send funds for this ReceivedCredit.
Possible enum values:
      - `ach`
        Funds received via ACH (Automated Clearing House) network.

      - `rtp`
        Funds received via the RTP (Real Time Payments) network.

      - `us_domestic_wire`
        Funds received via the Fedwire domestic US network.

    - `bank_transfer.us_bank_account.routing_number` (string, nullable)
      The routing number of the account that originated the transfer.

- `created` (timestamp)
  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.

- `description` (string, nullable)
  Freeform string set by originator of the ReceivedCredit.

- `financial_account` (string)
  Financial Account ID on which funds for ReceivedCredit were received.

- `livemode` (boolean)
  Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

- `receipt_url` (string, nullable)
  A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

- `status` (enum)
  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_details` (object, nullable)
  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_details.failed` (object, nullable)
    Hash that provides additional information regarding the reason behind a `failed` ReceivedCredit status. It is only present when the ReceivedCredit status is `failed`.

    - `status_details.failed.reason` (enum)
      The `failed` status reason.
Possible enum values:
      - `capability_inactive`
        Funds rejected because the Financial Address feature on the associated Financial Account is inactive. Contact Stripe to re-enable the capability.

      - `currency_unsupported_on_financial_address`
        Funds were rejected due to a discrepancy between the currency of the funds and the supported currencies of the Financial Address.

      - `financial_address_inactive`
        Funds rejected because associated Financial Address that has been archived.

      - `stripe_rejected`
        Funds rejected by internal Stripe rules.

  - `status_details.returned` (object, nullable)
    Hash that provides additional information regarding the reason behind a `returned` ReceivedCredit status. It is only present when the ReceivedCredit status is `returned`.

    - `status_details.returned.reason` (enum)
      The `returned` status reason.
Possible enum values:
      - `originator_initiated_reversal`
        Funds were returned due to a request for reversal by the originating bank.

- `status_transitions` (object, nullable)
  Hash containing timestamps of when the object transitioned to a particular status.

  - `status_transitions.failed_at` (timestamp, nullable)
    Timestamp describing when the ReceivedCredit was marked as `failed`. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

  - `status_transitions.returned_at` (timestamp, nullable)
    Timestamp describing when the ReceivedCredit changed status to `returned`. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

  - `status_transitions.succeeded_at` (timestamp, nullable)
    Timestamp describing when the ReceivedCredit was marked as `succeeded`. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

- `type` (enum)
  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

```json
{
  "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
  }
}
```