--- title: "List all ReceivedCredits" method: GET path: "/v1/treasury/received_credits" --- # List all ReceivedCredits `GET /v1/treasury/received_credits` Returns a list of ReceivedCredits. ## Query parameters - `ending_before` string - `expand` string[] - `financial_account` string, required - `limit` integer - `linked_flows` object - `source_flow_type` 'credit_reversal' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'payout', required - `starting_after` string - `status` 'failed' | 'succeeded' ## Response `200` Successful response. - object - `data` TreasuryReceivedCredit[], required — Details about each object. - `amount` integer, required — Amount (in cents) transferred. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, required — An arbitrary string attached to the object. Often useful for displaying to users. - `failure_code` 'account_closed' | 'account_frozen' | 'international_transaction' | 'other', nullable — Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. - `financial_account` string, nullable — The FinancialAccount that received the funds. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `initiating_payment_method_details` TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails, required - `balance` 'payments' — Set when `type` is `balance`. - `billing_details` TreasurySharedResourceBillingDetails, required - `address` Address, required - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `email` string, nullable — Email address. - `name` string, nullable — Full name. - `financial_account` ReceivedPaymentMethodDetailsFinancialAccount - `id` string, required — The FinancialAccount ID. - `network` 'stripe', required — The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`. - `issuing_card` string — Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID. - `type` 'balance' | 'financial_account' | 'issuing_card' | 'stripe' | 'us_bank_account', required — Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount. - `us_bank_account` TreasurySharedResourceInitiatingPaymentMethodDetailsUsBankAccount - `bank_name` string, nullable — Bank name. - `last4` string, nullable — The last four digits of the bank account number. - `routing_number` string, nullable — The routing number for the bank account. - `linked_flows` TreasuryReceivedCreditsResourceLinkedFlows, required - `credit_reversal` string, nullable — The CreditReversal created as a result of this ReceivedCredit being reversed. - `issuing_authorization` string, nullable — Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object. - `issuing_transaction` string, nullable — Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object. - `source_flow` string, nullable — ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. - `source_flow_details` TreasuryReceivedCreditsResourceSourceFlowsDetails - `credit_reversal` TreasuryCreditReversal — You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. - `amount` integer, required — Amount (in cents) transferred. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `financial_account` string, required — The FinancialAccount to reverse funds from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network` 'ach' | 'stripe', required — The rails used to reverse the funds. - `object` 'treasury.credit_reversal', required — String representing the object's type. Objects of the same type share the same value. - `received_credit` string, required — The ReceivedCredit being reversed. - `status` 'canceled' | 'posted' | 'processing', required — Status of the CreditReversal - `status_transitions` TreasuryReceivedCreditsResourceStatusTransitions, required - `posted_at` integer, nullable — Timestamp describing when the CreditReversal changed status to `posted` - `transaction` union — The Transaction associated with this object. - string - TreasuryTransaction — Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. - … - `outbound_payment` TreasuryOutboundPayment — Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) - `amount` integer, required — Amount (in cents) transferred. - `cancelable` boolean, required — Returns `true` if the object can be canceled, and `false` otherwise. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` string, nullable — ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination_payment_method` string, nullable — The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. - `destination_payment_method_details` OutboundPaymentsPaymentMethodDetails - `billing_details` TreasurySharedResourceBillingDetails, required - … - `financial_account` OutboundPaymentsPaymentMethodDetailsFinancialAccount - … - `type` 'financial_account' | 'us_bank_account', required — The type of the payment method used in the OutboundPayment. - `us_bank_account` OutboundPaymentsPaymentMethodDetailsUsBankAccount - … - `end_user_details` TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails - `ip_address` string, nullable — IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. - `present` boolean, required — `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. - `expected_arrival_date` integer, required — The date when funds are expected to arrive in the destination account. - `financial_account` string, required — The FinancialAccount that funds were pulled from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'treasury.outbound_payment', required — String representing the object's type. Objects of the same type share the same value. - `returned_details` TreasuryOutboundPaymentsResourceReturnedStatus - `code` 'account_closed' | 'account_frozen' | 'bank_account_restricted' | 'bank_ownership_changed' | 'declined' | 'incorrect_account_holder_name' | 'invalid_account_number' | 'invalid_currency' | 'no_account' | 'other', required — Reason for the return. - `transaction` union, required — The Transaction associated with this object. - … - `statement_descriptor` string, required — The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). - `status` 'canceled' | 'failed' | 'posted' | 'processing' | 'returned', required — Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`. - `status_transitions` TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions, required - `canceled_at` integer, nullable — Timestamp describing when an OutboundPayment changed status to `canceled`. - `failed_at` integer, nullable — Timestamp describing when an OutboundPayment changed status to `failed`. - `posted_at` integer, nullable — Timestamp describing when an OutboundPayment changed status to `posted`. - `returned_at` integer, nullable — Timestamp describing when an OutboundPayment changed status to `returned`. - `tracking_details` TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails - `ach` TreasuryOutboundPaymentsResourceAchTrackingDetails - … - `type` 'ach' | 'us_domestic_wire', required — The US bank account network used to send funds. - `us_domestic_wire` TreasuryOutboundPaymentsResourceUsDomesticWireTrackingDetails - … - `transaction` union, required — The Transaction associated with this object. - string - TreasuryTransaction — Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. - … - `outbound_transfer` TreasuryOutboundTransfer — Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) - `amount` integer, required — Amount (in cents) transferred. - `cancelable` boolean, required — Returns `true` if the object can be canceled, and `false` otherwise. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination_payment_method` string, nullable — The PaymentMethod used as the payment instrument for an OutboundTransfer. - `destination_payment_method_details` OutboundTransfersPaymentMethodDetails, required - `billing_details` TreasurySharedResourceBillingDetails, required - … - `financial_account` OutboundTransfersPaymentMethodDetailsFinancialAccount - … - `type` 'financial_account' | 'us_bank_account', required — The type of the payment method used in the OutboundTransfer. - `us_bank_account` OutboundTransfersPaymentMethodDetailsUsBankAccount - … - `expected_arrival_date` integer, required — The date when funds are expected to arrive in the destination account. - `financial_account` string, required — The FinancialAccount that funds were pulled from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'treasury.outbound_transfer', required — String representing the object's type. Objects of the same type share the same value. - `returned_details` TreasuryOutboundTransfersResourceReturnedDetails - `code` 'account_closed' | 'account_frozen' | 'bank_account_restricted' | 'bank_ownership_changed' | 'declined' | 'incorrect_account_holder_name' | 'invalid_account_number' | 'invalid_currency' | 'no_account' | 'other', required — Reason for the return. - `transaction` union, required — The Transaction associated with this object. - … - `statement_descriptor` string, required — Information about the OutboundTransfer to be sent to the recipient account. - `status` 'canceled' | 'failed' | 'posted' | 'processing' | 'returned', required — Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`. - `status_transitions` TreasuryOutboundTransfersResourceStatusTransitions, required - `canceled_at` integer, nullable — Timestamp describing when an OutboundTransfer changed status to `canceled` - `failed_at` integer, nullable — Timestamp describing when an OutboundTransfer changed status to `failed` - `posted_at` integer, nullable — Timestamp describing when an OutboundTransfer changed status to `posted` - `returned_at` integer, nullable — Timestamp describing when an OutboundTransfer changed status to `returned` - `tracking_details` TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails - `ach` TreasuryOutboundTransfersResourceAchTrackingDetails - … - `type` 'ach' | 'us_domestic_wire', required — The US bank account network used to send funds. - `us_domestic_wire` TreasuryOutboundTransfersResourceUsDomesticWireTrackingDetails - … - `transaction` union, required — The Transaction associated with this object. - string - TreasuryTransaction — Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. - … - `payout` Payout — A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://docs.stripe.com/payouts) - `amount` integer, required — The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. - `application_fee` union — The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. - string - ApplicationFee - … - `application_fee_amount` integer, nullable — The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. - `arrival_date` integer, required — Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. - `automatic` boolean, required — Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). - `balance_transaction` union — ID of the balance transaction that describes the impact of this payout on your account balance. - string - BalanceTransaction — Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination` union — ID of the bank account or card the payout is sent to. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - DeletedBankAccount - … - DeletedCard - … - `failure_balance_transaction` union — If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. - string - BalanceTransaction — Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) - … - `failure_code` string, nullable — Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures). - `failure_message` string, nullable — Message that provides the reason for a payout failure, if available. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `method` string, required — The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). - `object` 'payout', required — String representing the object's type. Objects of the same type share the same value. - `original_payout` union — If the payout reverses another, this is the ID of the original payout. - string - Payout — recursive - `payout_method` string, nullable — ID of the v2 FinancialAccount the funds are sent to. - `reconciliation_status` 'completed' | 'in_progress' | 'not_applicable', required — If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. - `reversed_by` union — If the payout reverses, this is the ID of the payout that reverses this payout. - string - Payout — recursive - `source_type` string, required — The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. - `statement_descriptor` string, nullable — Extra information about a payout that displays on the user's bank statement. - `status` string, required — Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. - `trace_id` PayoutsTraceId - `status` string, required — Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. - `value` string, nullable — The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. - `type` 'bank_account' | 'card', required — Can be `bank_account` or `card`. - `type` 'credit_reversal' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'payout', required — The type of the source flow that originated the ReceivedCredit. - `source_flow_type` string, nullable — The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). - `livemode` boolean, 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' | 'us_domestic_wire', required — The rails used to send the funds. - `object` 'treasury.received_credit', required — String representing the object's type. Objects of the same type share the same value. - `reversal_details` TreasuryReceivedCreditsResourceReversalDetails - `deadline` integer, nullable — Time before which a ReceivedCredit can be reversed. - `restricted_reason` 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted', nullable — Set if a ReceivedCredit cannot be reversed. - `status` 'failed' | 'succeeded', required — Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field. - `transaction` union — The Transaction associated with this object. - string - TreasuryTransaction — Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. - `amount` integer, required — Amount (in cents) transferred. - `balance_impact` TreasuryTransactionsResourceBalanceImpact, required — Change to a FinancialAccount's balance - `cash` integer, required — The change made to funds the user can spend right now. - `inbound_pending` integer, required — The change made to funds that are not spendable yet, but will become available at a later time. - `outbound_pending` integer, required — The change made to funds in the account, but not spendable because they are being held for pending outbound flows. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, required — An arbitrary string attached to the object. Often useful for displaying to users. - `entries` object, nullable — A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. - `data` TreasuryTransactionEntry[], required — Details about each object. - `balance_impact` TreasuryTransactionsResourceBalanceImpact, required — Change to a FinancialAccount's balance - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `effective_at` integer, required — When the TransactionEntry will impact the FinancialAccount's balance. - `financial_account` string, required — The FinancialAccount associated with this object. - `flow` string, nullable — Token of the flow associated with the TransactionEntry. - `flow_details` TreasuryTransactionsResourceFlowDetails - … - `flow_type` 'credit_reversal' | 'debit_reversal' | 'inbound_transfer' | 'issuing_authorization' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'received_credit' | 'received_debit', required — Type of the flow associated with the TransactionEntry. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'treasury.transaction_entry', required — String representing the object's type. Objects of the same type share the same value. - `transaction` union, required — The Transaction associated with this object. - … - `type` 'credit_reversal' | 'credit_reversal_posting' | 'debit_reversal' | 'inbound_transfer' | 'inbound_transfer_return' | 'issuing_authorization_hold' | 'issuing_authorization_release' | 'other' | 'outbound_payment' | 'outbound_payment_cancellation' | 'outbound_payment_failure' | 'outbound_payment_posting' | 'outbound_payment_return' | 'outbound_transfer' | 'outbound_transfer_cancellation' | 'outbound_transfer_failure' | 'outbound_transfer_posting' | 'outbound_transfer_return' | 'received_credit' | 'received_debit', required — The specific money movement that generated the TransactionEntry. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `financial_account` string, required — The FinancialAccount associated with this object. - `flow` string, nullable — ID of the flow that created the Transaction. - `flow_details` TreasuryTransactionsResourceFlowDetails - `credit_reversal` TreasuryCreditReversal — You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. - `amount` integer, required — Amount (in cents) transferred. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `financial_account` string, required — The FinancialAccount to reverse funds from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network` 'ach' | 'stripe', required — The rails used to reverse the funds. - `object` 'treasury.credit_reversal', required — String representing the object's type. Objects of the same type share the same value. - `received_credit` string, required — The ReceivedCredit being reversed. - `status` 'canceled' | 'posted' | 'processing', required — Status of the CreditReversal - `status_transitions` TreasuryReceivedCreditsResourceStatusTransitions, required - … - `transaction` union — The Transaction associated with this object. - … - `debit_reversal` TreasuryDebitReversal — You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. - `amount` integer, required — Amount (in cents) transferred. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `financial_account` string, nullable — The FinancialAccount to reverse funds from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `linked_flows` TreasuryReceivedDebitsResourceDebitReversalLinkedFlows - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network` 'ach' | 'card', required — The rails used to reverse the funds. - `object` 'treasury.debit_reversal', required — String representing the object's type. Objects of the same type share the same value. - `received_debit` string, required — The ReceivedDebit being reversed. - `status` 'failed' | 'processing' | 'succeeded', required — Status of the DebitReversal - `status_transitions` TreasuryReceivedDebitsResourceStatusTransitions, required - … - `transaction` union — The Transaction associated with this object. - … - `inbound_transfer` TreasuryInboundTransfer — Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) - `amount` integer, required — Amount (in cents) transferred. - `cancelable` boolean, required — Returns `true` if the InboundTransfer is able to be canceled. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `failure_details` TreasuryInboundTransfersResourceFailureDetails - … - `financial_account` string, required — The FinancialAccount that received the funds. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `linked_flows` TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows, required - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'treasury.inbound_transfer', required — String representing the object's type. Objects of the same type share the same value. - `origin_payment_method` string, nullable — The origin payment method to be debited for an InboundTransfer. - `origin_payment_method_details` InboundTransfers - … - `returned` boolean, nullable — Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. - `statement_descriptor` string, required — Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. - `status` 'canceled' | 'failed' | 'processing' | 'succeeded', required — Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails. - `status_transitions` TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions, required - … - `transaction` union — The Transaction associated with this object. - … - `issuing_authorization` IssuingAuthorization — When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) - `amount` integer, required — The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. - `amount_details` IssuingAuthorizationAmountDetails - … - `approved` boolean, required — Whether the authorization has been approved. - `authorization_method` 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe', required — How the card details were provided. - `balance_transactions` BalanceTransaction[], required — List of balance transactions associated with this authorization. - … - `card` IssuingCard, required — You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders. - … - `card_presence` 'not_present' | 'present', nullable — Whether the card was present at the point of sale for the authorization. - `cardholder` union — The cardholder to whom this authorization belongs. - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `fleet` IssuingAuthorizationFleetData - … - `fraud_challenges` IssuingAuthorizationFraudChallenge[], nullable — Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. - … - `fuel` IssuingAuthorizationFuelData - … - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `merchant_amount` integer, required — The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. - `merchant_currency` string, currency, required — The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `merchant_data` IssuingAuthorizationMerchantData, required - … - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `network_data` IssuingAuthorizationNetworkData - … - `object` 'issuing.authorization', required — String representing the object's type. Objects of the same type share the same value. - `pending_request` IssuingAuthorizationPendingRequest - … - `request_history` IssuingAuthorizationRequest[], required — History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. - … - `status` 'closed' | 'expired' | 'pending' | 'reversed', required — The current status of the authorization in its lifecycle. - `token` union — [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. - … - `transactions` IssuingTransaction[], required — List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. - … - `treasury` IssuingAuthorizationTreasury - … - `verification_data` IssuingAuthorizationVerificationData, required - … - `verified_by_fraud_challenge` boolean, nullable — Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. - `wallet` string, nullable — The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. - `outbound_payment` TreasuryOutboundPayment — Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) - `amount` integer, required — Amount (in cents) transferred. - `cancelable` boolean, required — Returns `true` if the object can be canceled, and `false` otherwise. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` string, nullable — ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination_payment_method` string, nullable — The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. - `destination_payment_method_details` OutboundPaymentsPaymentMethodDetails - … - `end_user_details` TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails - … - `expected_arrival_date` integer, required — The date when funds are expected to arrive in the destination account. - `financial_account` string, required — The FinancialAccount that funds were pulled from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'treasury.outbound_payment', required — String representing the object's type. Objects of the same type share the same value. - `returned_details` TreasuryOutboundPaymentsResourceReturnedStatus - … - `statement_descriptor` string, required — The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). - `status` 'canceled' | 'failed' | 'posted' | 'processing' | 'returned', required — Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`. - `status_transitions` TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions, required - … - `tracking_details` TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails - … - `transaction` union, required — The Transaction associated with this object. - … - `outbound_transfer` TreasuryOutboundTransfer — Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) - `amount` integer, required — Amount (in cents) transferred. - `cancelable` boolean, required — Returns `true` if the object can be canceled, and `false` otherwise. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `destination_payment_method` string, nullable — The PaymentMethod used as the payment instrument for an OutboundTransfer. - `destination_payment_method_details` OutboundTransfersPaymentMethodDetails, required - … - `expected_arrival_date` integer, required — The date when funds are expected to arrive in the destination account. - `financial_account` string, required — The FinancialAccount that funds were pulled from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `object` 'treasury.outbound_transfer', required — String representing the object's type. Objects of the same type share the same value. - `returned_details` TreasuryOutboundTransfersResourceReturnedDetails - … - `statement_descriptor` string, required — Information about the OutboundTransfer to be sent to the recipient account. - `status` 'canceled' | 'failed' | 'posted' | 'processing' | 'returned', required — Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`. - `status_transitions` TreasuryOutboundTransfersResourceStatusTransitions, required - … - `tracking_details` TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails - … - `transaction` union, required — The Transaction associated with this object. - … - `received_credit` TreasuryReceivedCredit — recursive - `received_debit` TreasuryReceivedDebit — ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount. - `amount` integer, required — Amount (in cents) transferred. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `description` string, 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_account` string, nullable — The FinancialAccount that funds were pulled from. - `hosted_regulatory_receipt_url` string, nullable — A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. - `id` string, required — Unique identifier for the object. - `initiating_payment_method_details` TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails - … - `linked_flows` TreasuryReceivedDebitsResourceLinkedFlows, required - … - `livemode` boolean, 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. - `reversal_details` TreasuryReceivedDebitsResourceReversalDetails - … - `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`. - `transaction` union — The Transaction associated with this object. - … - `type` 'credit_reversal' | 'debit_reversal' | 'inbound_transfer' | 'issuing_authorization' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'received_credit' | 'received_debit', required — Type of the flow that created the Transaction. Set to the same value as `flow_type`. - `flow_type` 'credit_reversal' | 'debit_reversal' | 'inbound_transfer' | 'issuing_authorization' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'received_credit' | 'received_debit', required — Type of the flow that created the Transaction. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'treasury.transaction', required — String representing the object's type. Objects of the same type share the same value. - `status` 'open' | 'posted' | 'void', required — Status of the Transaction. - `status_transitions` TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions, required - `posted_at` integer, nullable — Timestamp describing when the Transaction changed status to `posted`. - `void_at` integer, nullable — Timestamp describing when the Transaction changed status to `void`. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/stripe-api.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api/versions/707de00b0616/schema)