Test mode: Create a ReceivedCredit

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.

post/v1/test_helpers/treasury/received_credits

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/treasury/received_credits
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

descriptionstring 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_accountstring nullable

The FinancialAccount that received the funds.

hosted_regulatory_receipt_urlstring nullable

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

idstring required

Unique identifier for the object.

livemodeboolean 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' | 'rtp' | '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.

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.

Changes

No operation changes found yet. Some revisions have not been checked.