Sample - Stripe API
GET/v1/treasury/received_credits/{id}

Retrieve a received credit

Retrieves a specific received credit by its unique identifier. Use expand when you need selected fields returned in expanded form.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the received credit. Must be no more than 5,000 characters.
expandarray<string>optional
Fields to expand in the response. Each field name must be no more than 5,000 characters.

2 status codes
200Returns the received credit, including its amount, currency, receiving financial account, network, status, linked flows, and failure details when applicable.
amountintegerrequired
Amount (in cents) transferred.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
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).
descriptionstringrequired
An arbitrary string attached to the object. Often useful for displaying to users.
failure_codestringoptional
Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
Allowed:account_closedaccount_frozeninternational_transactionother
financial_accountstringoptional
The FinancialAccount that received the funds.
hosted_regulatory_receipt_urlstringoptional
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.
idstringrequired
Unique identifier for the object.
initiating_payment_method_detailsobjectrequired
linked_flowsobjectrequired
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
networkstringrequired
The rails used to send the funds.
Allowed:achcardstripeus_domestic_wire
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:treasury.received_credit
reversal_detailsobjectoptional
Details describing when a ReceivedCredit may be reversed.
statusstringrequired
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.
Allowed:failedsucceeded
transactionstringoptional
The Transaction associated with this object.
defaultError response.
errorobjectrequired

Error handling

id must identify the received credit to retrieve and must be no more than 5,000 characters. Each value in expand must be a string of no more than 5,000 characters.