The ReceivedCredit object 

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.

  Hide child attributes

  • amount.currencystring

    A lowercase alpha3 currency code like “usd”.

  • amount.valueinteger

    In minor units like 123 for 1.23 USD.

• 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.

  Hide child attributes

  • balance_transfer.from_accountnullable string

    The ID of the account that owns the source object originated the ReceivedCredit.

  • balance_transfer.outbound_paymentnullable string

    The ID of the outbound payment object that originated the ReceivedCredit.

  • balance_transfer.outbound_transfernullable string

    The ID of the outbound transfer object that originated the ReceivedCredit.

  • balance_transfer.payout_v1nullable string

    The ID of the payout object that originated the ReceivedCredit.

  • balance_transfer.typeenum

    The type of Stripe Money Movement that originated the ReceivedCredit.

    Possible enum values

    outbound_payment Balance transfer initiated by v2 outbound payment.

    outbound_transfer Balance transfer initiated by v2 outbound transfer.

    payout_v1 Balance transfer initiated by v1 payouts request.

• 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.

  Hide child attributes

  • bank_transfer.financial_addressstring

    Financial Address on which funds for ReceivedCredit were received.

  • bank_transfer.gb_bank_accountnullable object

    Hash containing the transaction bank details. Present if payment_method_type field value is gb_bank_account.

    Hide child attributes

    • bank_transfer.gb_bank_account.account_holder_namenullable string

      The bank name the transfer was received from.

    • bank_transfer.gb_bank_account.bank_namenullable string

      The bank name the transfer was received from.

    • bank_transfer.gb_bank_account.last4nullable string

      The last 4 digits of the account number that originated the transfer.

    • bank_transfer.gb_bank_account.networkenum

      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_codenullable string

      The sort code of the account that originated the transfer.

  • bank_transfer.payment_method_typeenum

    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_descriptornullable string

    Freeform string set by originator of the external ReceivedCredit.

  • bank_transfer.us_bank_accountnullable object

    Hash containing the transaction bank details. Present if payment_method_type field value is us_bank_account.

    Hide child attributes

    • bank_transfer.us_bank_account.bank_namenullable string

      The bank name the transfer was received from.

    • bank_transfer.us_bank_account.last4nullable string

      The last 4 digits of the account number that originated the transfer.

    • bank_transfer.us_bank_account.networkenum

      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_numbernullable string

      The routing number of the account that originated the transfer.

• 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.

  Hide child attributes

  • status_details.failednullable object

    Hash that provides additional information regarding the reason behind a failed ReceivedCredit status. It is only present when the ReceivedCredit status is failed.

    Hide child attributes

    • status_details.failed.reasonenum

      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.returnednullable object

    Hash that provides additional information regarding the reason behind a returned ReceivedCredit status. It is only present when the ReceivedCredit status is returned.

    Hide child attributes

    • status_details.returned.reasonenum

      The returned status reason.

      Possible enum values

      originator_initiated_reversal Funds were returned due to a request for reversal by the originating bank.

• status_transitionsnullable object

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

  Hide child attributes

  • status_transitions.failed_atnullable timestamp

    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_atnullable timestamp

    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_atnullable timestamp

    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.

• 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.