Test mode: Create a ReceivedCredit Test helper
Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.
Parameters
- amountintegerRequired
Amount (in cents) to be transferred.
- currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial_
accountstringRequired The FinancialAccount to send funds to.
- networkenumRequired
Specifies the network rails to be used. If not set, will default to the PaymentMethod’s preferred network. See the docs to learn more about money movement timelines for each network type.
- descriptionstring
An arbitrary string attached to the object. Often useful for displaying to users.
- initiating_
payment_ method_ detailsobject Initiating payment method details for the object.
- initiating_payment_method_details.
typeenumRequired The source type.
- initiating_payment_method_details.
us_ bank_ accountobject Optional fields for
us_
.bank_ account - initiating_payment_method_details.
us_bank_account. account_ holder_ namestring The bank account holder’s name.
- initiating_payment_method_details.
us_bank_account. account_ numberstring The bank account number.
- initiating_payment_method_details.
us_bank_account. routing_ numberstring The bank account’s routing number.
Returns
A test mode ReceivedCredit object.
{ "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"}