Returns a list of ReceivedCredits.
Parameters
- financial_
accountstring The FinancialAccount that received the funds.
- linked_
flowsobject Only return ReceivedCredits described by the flow.
- linked_flows.
source_ flow_ typeenumRequired The source flow type.
Possible enum valuescredit_
reversal ReceivedCredits that were reversed and have associated CreditReversals.
other
ReceivedCredits created from other source flow.
outbound_
payment ReceivedCredits created from OutboundPayments.
outbound_
transfer ReceivedCredits created from OutboundPayments.
payout
ReceivedCredits created from Payouts.
- statusenum
Only return ReceivedCredits that have the given status:
succeeded
orfailed
.Possible enum valuesfailed
The ReceivedCredit was declined, and no Transaction was created.
succeeded
The ReceivedCredit was approved.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
ReceivedCredits, starting after ReceivedCredit starting_
. Each entry in the array is a separate ReceivedCredit object. If no more ReceivedCredits are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/treasury/received_credits", "has_more": false, "data": [ { "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw", "object": "treasury.received_credit", "amount": 1000, "created": 1680755425, "currency": "usd", "description": "Stripe Test", "failure_code": null, "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw", "initiating_payment_method_details": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "Jane Austen" }, "type": "us_bank_account", "us_bank_account": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "routing_number": "110000000" } }, "linked_flows": { "credit_reversal": null, "issuing_authorization": null, "issuing_transaction": null, "source_flow": null, "source_flow_type": null }, "livemode": false, "network": "ach", "reversal_details": { "deadline": 1681084800, "restricted_reason": null }, "status": "succeeded", "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0" } ]}