Create a test-mode force capture

Allows the user to capture an arbitrary amount, also known as a forced capture.

post/v1/test_helpers/issuing/transactions/create_force_capture

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/issuing/transactions/create_force_capture
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Response

Successful response.

amountinteger required

The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.

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.

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.

merchant_amountinteger required

The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.

merchant_currencystring currency required

The currency with which the merchant is taking payment.

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'issuing.transaction' required

String representing the object's type. Objects of the same type share the same value.

type'capture' | 'refund' required

The nature of the transaction.

wallet'apple_pay' | 'google_pay' | 'samsung_pay' nullable

The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.

Changes

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