Expire a test-mode authorization

Expire a test-mode Authorization.

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

Path parameters

authorizationstring required

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

Changed in 9 of the 51 revisions of this API.161624

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status

      response-optional-property-added

  • 1199cc3c557429See the full diff
    • the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default

      response-property-became-optional

    • the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default

      response-property-became-optional

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/acss_debit/anyOf[subschema #1: payment_intent_payment_method_options_acss_debit]/target_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/au_becs_debit/anyOf[subschema #1: payment_intent_payment_method_options_au_becs_debit]/target_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/bacs_debit/anyOf[subschema #1: payment_intent_payment_method_options_bacs_debit]/target_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/sepa_debit/anyOf[subschema #1: payment_intent_payment_method_options_sepa_debit]/target_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/us_bank_account/anyOf[subschema #1: payment_intent_payment_method_options_us_bank_account]/target_date to the response with the default status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property error/advice_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/pay_by_bank to the response with the default status

      response-optional-property-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/customer_tax_ids/items/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription_schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription_schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/network_transaction_id to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/network_transaction_id to the response with the default status

      response-optional-property-added

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/refunds/data/items/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.