Test mode: Fail an OutboundPayment

Changed on

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

post/v1/test_helpers/treasury/outbound_payments/{id}/fail

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/treasury/outbound_payments/{id}/fail
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

idstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

cancelableboolean required

Returns true if the object can be canceled, and false otherwise.

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.

customerstring nullable

ID of the customer to whom an OutboundPayment is sent.

descriptionstring nullable

An arbitrary string attached to the object. Often useful for displaying to users.

destination_payment_methodstring nullable

The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.

expected_arrival_dateinteger required

The date when funds are expected to arrive in the destination account.

financial_accountstring required

The FinancialAccount that funds were pulled from.

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.

metadataobject required

Set of key-value pairs 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.

statement_descriptorstring 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.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.