Capture a test-mode authorization

Changed on

Capture a test-mode authorization.

post/v1/test_helpers/issuing/authorizations/{authorization}/capture

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/issuing/authorizations/{authorization}/capture
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

authorizationstring required

Request body application/x-www-form-urlencoded

capture_amountinteger

The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the smallest currency unit.

close_authorizationboolean

Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger required

The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. amount should be the same as merchant_amount, unless currency and merchant_currency are different.

approvedboolean required

Whether the authorization has been approved.

authorization_method'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe' required

How the card details were provided.

card_presence'not_present' | 'present' nullable

Whether the card was present at the point of sale for the authorization.

createdinteger required

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

currencystring currency required

The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization. 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 total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit. merchant_amount should be the same as amount, unless merchant_currency and currency are different.

merchant_currencystring currency required

The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.

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.authorization' required

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

status'closed' | 'expired' | 'pending' | 'reversed' required

The current status of the authorization in its lifecycle.

verified_by_fraud_challengeboolean nullable

Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.

walletstring nullable

The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized.

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.