class Stripe::TestHelpersApi

Defined in:

stripe/api/test_helpers_api.cr

Constant Summary

DELETE_TEST_HELPERS_TEST_CLOCKS_TEST_CLOCK_MAX_LENGTH_FOR_TEST_CLOCK = 5000
GET_TEST_HELPERS_TEST_CLOCKS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_TEST_HELPERS_TEST_CLOCKS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_TEST_HELPERS_TEST_CLOCKS_TEST_CLOCK_MAX_LENGTH_FOR_TEST_CLOCK = 5000
POST_TEST_HELPERS_CONFIRMATION_TOKENS_MAX_LENGTH_FOR_PAYMENT_METHOD = 5000
POST_TEST_HELPERS_CONFIRMATION_TOKENS_VALID_VALUES_FOR_SETUP_FUTURE_USAGE = String.static_array("off_session", "on_session")
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_AUTHORIZATION_CAPTURE_MAX_LENGTH_FOR_AUTHORIZATION = 5000
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_AUTHORIZATION_EXPIRE_MAX_LENGTH_FOR_AUTHORIZATION = 5000
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_AUTHORIZATION_INCREMENT_MAX_LENGTH_FOR_AUTHORIZATION = 5000
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_AUTHORIZATION_REVERSE_MAX_LENGTH_FOR_AUTHORIZATION = 5000
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_MAX_LENGTH_FOR_CARD = 5000
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_VALID_VALUES_FOR_AUTHORIZATION_METHOD = String.static_array("chip", "contactless", "keyed_in", "online", "swipe")
POST_TEST_HELPERS_ISSUING_AUTHORIZATIONS_VALID_VALUES_FOR_WALLET = String.static_array("apple_pay", "google_pay", "samsung_pay")
POST_TEST_HELPERS_ISSUING_CARDS_CARD_SHIPPING_FAIL_MAX_LENGTH_FOR_CARD = 5000
POST_TEST_HELPERS_ISSUING_CARDS_CARD_SHIPPING_RETURN_MAX_LENGTH_FOR_CARD = 5000
POST_TEST_HELPERS_ISSUING_CARDS_CARD_SHIPPING_SHIP_MAX_LENGTH_FOR_CARD = 5000
POST_TEST_HELPERS_ISSUING_PERSONALIZATION_DESIGNS_PERSONALIZATION_DESIGN_ACTIVATE_MAX_LENGTH_FOR_PERSONALIZATION_DESIGN = 5000
POST_TEST_HELPERS_ISSUING_PERSONALIZATION_DESIGNS_PERSONALIZATION_DESIGN_DEACTIVATE_MAX_LENGTH_FOR_PERSONALIZATION_DESIGN = 5000
POST_TEST_HELPERS_ISSUING_PERSONALIZATION_DESIGNS_PERSONALIZATION_DESIGN_REJECT_MAX_LENGTH_FOR_PERSONALIZATION_DESIGN = 5000
POST_TEST_HELPERS_ISSUING_TRANSACTIONS_CREATE_FORCE_CAPTURE_MAX_LENGTH_FOR_CARD = 5000
POST_TEST_HELPERS_ISSUING_TRANSACTIONS_CREATE_UNLINKED_REFUND_MAX_LENGTH_FOR_CARD = 5000
POST_TEST_HELPERS_ISSUING_TRANSACTIONS_TRANSACTION_REFUND_MAX_LENGTH_FOR_TRANSACTION = 5000
POST_TEST_HELPERS_TERMINAL_READERS_READER_PRESENT_PAYMENT_METHOD_MAX_LENGTH_FOR_READER = 5000
POST_TEST_HELPERS_TERMINAL_READERS_READER_PRESENT_PAYMENT_METHOD_VALID_VALUES_FOR__TYPE = String.static_array("card_present", "interac_present")
POST_TEST_HELPERS_TEST_CLOCKS_MAX_LENGTH_FOR_NAME = 300
POST_TEST_HELPERS_TEST_CLOCKS_TEST_CLOCK_ADVANCE_MAX_LENGTH_FOR_TEST_CLOCK = 5000
POST_TEST_HELPERS_TREASURY_INBOUND_TRANSFERS_ID_FAIL_MAX_LENGTH_FOR_ID = 5000
POST_TEST_HELPERS_TREASURY_INBOUND_TRANSFERS_ID_SUCCEED_MAX_LENGTH_FOR_ID = 5000
POST_TEST_HELPERS_TREASURY_OUTBOUND_PAYMENTS_ID_FAIL_MAX_LENGTH_FOR_ID = 5000
POST_TEST_HELPERS_TREASURY_OUTBOUND_PAYMENTS_ID_POST_MAX_LENGTH_FOR_ID = 5000
POST_TEST_HELPERS_TREASURY_OUTBOUND_PAYMENTS_ID_RETURN_MAX_LENGTH_FOR_ID = 5000
POST_TEST_HELPERS_TREASURY_OUTBOUND_TRANSFERS_OUTBOUND_TRANSFER_FAIL_MAX_LENGTH_FOR_OUTBOUND_TRANSFER = 5000
POST_TEST_HELPERS_TREASURY_OUTBOUND_TRANSFERS_OUTBOUND_TRANSFER_POST_MAX_LENGTH_FOR_OUTBOUND_TRANSFER = 5000
POST_TEST_HELPERS_TREASURY_OUTBOUND_TRANSFERS_OUTBOUND_TRANSFER_RETURN_MAX_LENGTH_FOR_OUTBOUND_TRANSFER = 5000
POST_TEST_HELPERS_TREASURY_RECEIVED_CREDITS_MAX_LENGTH_FOR_DESCRIPTION = 5000
POST_TEST_HELPERS_TREASURY_RECEIVED_CREDITS_VALID_VALUES_FOR_NETWORK = String.static_array("ach", "us_domestic_wire")
POST_TEST_HELPERS_TREASURY_RECEIVED_DEBITS_MAX_LENGTH_FOR_DESCRIPTION = 5000
POST_TEST_HELPERS_TREASURY_RECEIVED_DEBITS_VALID_VALUES_FOR_NETWORK = String.static_array("ach")

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_delete_test_helpers_test_clocks_test_clock(*, test_clock : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_test_helpers_test_clocks(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_test_helpers_test_clocks_test_clock(*, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_confirmation_tokens(*, expand : Array(String) | Nil = nil, payment_method : String | Nil = nil, payment_method_data : Stripe::PaymentMethodDataParams | Nil = nil, return_url : String | Nil = nil, setup_future_usage : String | Nil = nil, shipping : Stripe::RecipientShippingWithOptionalFieldsAddress | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_authorizations(*, amount : Int64 | Nil = nil, card : String | Nil = nil, amount_details : Stripe::AmountDetailsSpecs | Nil = nil, authorization_method : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, fleet : Stripe::FleetTestmodeAuthorizationSpecs | Nil = nil, fuel : Stripe::FuelSpecs | Nil = nil, is_amount_controllable : Bool | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, network_data : Stripe::NetworkDataSpecs | Nil = nil, verification_data : Stripe::VerificationDataSpecs | Nil = nil, wallet : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_authorizations_authorization_capture(*, authorization : String | Nil = nil, capture_amount : Int64 | Nil = nil, close_authorization : Bool | Nil = nil, expand : Array(String) | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_authorizations_authorization_expire(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_authorizations_authorization_increment(*, authorization : String | Nil = nil, increment_amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, is_amount_controllable : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_authorizations_authorization_reverse(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil, reverse_amount : Int64 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_cards_card_shipping_fail(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_cards_card_shipping_return(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_cards_card_shipping_ship(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_personalization_designs_personalization_design_activate(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_personalization_designs_personalization_design_deactivate(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_personalization_designs_personalization_design_reject(*, personalization_design : String | Nil = nil, rejection_reasons : Stripe::RejectionReasonsParam | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_transactions_create_force_capture(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_transactions_create_unlinked_refund(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_issuing_transactions_transaction_refund(*, transaction : String | Nil = nil, expand : Array(String) | Nil = nil, refund_amount : Int64 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_terminal_readers_reader_present_payment_method(*, reader : String | Nil = nil, amount_tip : Int64 | Nil = nil, card_present : Stripe::CardPresent | Nil = nil, expand : Array(String) | Nil = nil, interac_present : Stripe::InteracPresent | Nil = nil, _type : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_test_clocks(*, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_test_clocks_test_clock_advance(*, test_clock : String | Nil = nil, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_inbound_transfers_id_fail(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, failure_details : Stripe::FailureDetailsParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_inbound_transfers_id_succeed(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_outbound_payments_id_fail(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_outbound_payments_id_post(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_outbound_payments_id_return(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_outbound_transfers_outbound_transfer_fail(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_outbound_transfers_outbound_transfer_post(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_outbound_transfers_outbound_transfer_return(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_received_credits(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_test_helpers_treasury_received_debits(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete_test_helpers_test_clocks_test_clock(*, test_clock : String | Nil = nil) : Stripe::DeletedTestHelpersTestClock #

Deletes a test clock.

@required @param test_clock [String?] @return [Stripe::DeletedTestHelpersTestClock]

[View source]
def delete_test_helpers_test_clocks_test_clock(*, test_clock : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Deletes a test clock.</p> @required @param test_clock [String?] @return nil


[View source]
def delete_test_helpers_test_clocks_test_clock_with_http_info(*, test_clock : String | Nil = nil) : Tuple(Stripe::DeletedTestHelpersTestClock, Int32, Hash(String, Array(String) | String)) #

<p>Deletes a test clock.</p> @required @param test_clock [String?] @return [Tuple(Stripe::DeletedTestHelpersTestClock, Integer, Hash)] Stripe::DeletedTestHelpersTestClock, response status code and response headers


[View source]
def get_test_helpers_test_clocks(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BillingClocksResourceBillingClockList #

Returns a list of your test clocks.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::BillingClocksResourceBillingClockList]

[View source]
def get_test_helpers_test_clocks(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of your test clocks.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_test_helpers_test_clocks_test_clock(*, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TestHelpersTestClock #

Retrieves a test clock.

@required @param test_clock [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TestHelpersTestClock]

[View source]
def get_test_helpers_test_clocks_test_clock(*, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves a test clock.</p> @required @param test_clock [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_test_helpers_test_clocks_test_clock_with_http_info(*, test_clock : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TestHelpersTestClock, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves a test clock.</p> @required @param test_clock [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TestHelpersTestClock, Integer, Hash)] Stripe::TestHelpersTestClock, response status code and response headers


[View source]
def get_test_helpers_test_clocks_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BillingClocksResourceBillingClockList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of your test clocks.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BillingClocksResourceBillingClockList, Integer, Hash)] Stripe::BillingClocksResourceBillingClockList, response status code and response headers


[View source]
def post_test_helpers_confirmation_tokens(*, expand : Array(String) | Nil = nil, payment_method : String | Nil = nil, payment_method_data : Stripe::PaymentMethodDataParams | Nil = nil, return_url : String | Nil = nil, setup_future_usage : String | Nil = nil, shipping : Stripe::RecipientShippingWithOptionalFieldsAddress | Nil = nil) : Stripe::ConfirmationToken #

Creates a test mode Confirmation Token server side for your integration tests.

@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param payment_method [String?] ID of an existing PaymentMethod. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param return_url [String?] Return URL used to confirm the Intent. @optional @param setup_future_usage [String?] Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. @optional @param shipping [Stripe::RecipientShippingWithOptionalFieldsAddress?] @return [Stripe::ConfirmationToken]

[View source]
def post_test_helpers_confirmation_tokens(*, expand : Array(String) | Nil = nil, payment_method : String | Nil = nil, payment_method_data : Stripe::PaymentMethodDataParams | Nil = nil, return_url : String | Nil = nil, setup_future_usage : String | Nil = nil, shipping : Stripe::RecipientShippingWithOptionalFieldsAddress | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a test mode Confirmation Token server side for your integration tests.</p> @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param payment_method [String?] ID of an existing PaymentMethod. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param return_url [String?] Return URL used to confirm the Intent. @optional @param setup_future_usage [String?] Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. @optional @param shipping [Stripe::RecipientShippingWithOptionalFieldsAddress?] @return nil


[View source]
def post_test_helpers_confirmation_tokens_with_http_info(*, expand : Array(String) | Nil = nil, payment_method : String | Nil = nil, payment_method_data : Stripe::PaymentMethodDataParams | Nil = nil, return_url : String | Nil = nil, setup_future_usage : String | Nil = nil, shipping : Stripe::RecipientShippingWithOptionalFieldsAddress | Nil = nil) : Tuple(Stripe::ConfirmationToken, Int32, Hash(String, Array(String) | String)) #

<p>Creates a test mode Confirmation Token server side for your integration tests.</p> @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param payment_method [String?] ID of an existing PaymentMethod. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param return_url [String?] Return URL used to confirm the Intent. @optional @param setup_future_usage [String?] Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. @optional @param shipping [Stripe::RecipientShippingWithOptionalFieldsAddress?] @return [Tuple(Stripe::ConfirmationToken, Integer, Hash)] Stripe::ConfirmationToken, response status code and response headers


[View source]
def post_test_helpers_issuing_authorizations(*, amount : Int64 | Nil = nil, card : String | Nil = nil, amount_details : Stripe::AmountDetailsSpecs | Nil = nil, authorization_method : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, fleet : Stripe::FleetTestmodeAuthorizationSpecs | Nil = nil, fuel : Stripe::FuelSpecs | Nil = nil, is_amount_controllable : Bool | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, network_data : Stripe::NetworkDataSpecs | Nil = nil, verification_data : Stripe::VerificationDataSpecs | Nil = nil, wallet : String | Nil = nil) : Stripe::IssuingAuthorization #

Create a test-mode authorization.

@required @param amount [Int32?] The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @required @param card [String?] Card associated with this authorization. @optional @param amount_details [Stripe::AmountDetailsSpecs?] @optional @param authorization_method [String?] How the card details were provided. Defaults to online. @optional @param currency [String?] The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param fleet [Stripe::FleetTestmodeAuthorizationSpecs?] @optional @param fuel [Stripe::FuelSpecs?] @optional @param is_amount_controllable [Bool?] If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param network_data [Stripe::NetworkDataSpecs?] @optional @param verification_data [Stripe::VerificationDataSpecs?] @optional @param wallet [String?] 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. @return [Stripe::IssuingAuthorization]

[View source]
def post_test_helpers_issuing_authorizations(*, amount : Int64 | Nil = nil, card : String | Nil = nil, amount_details : Stripe::AmountDetailsSpecs | Nil = nil, authorization_method : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, fleet : Stripe::FleetTestmodeAuthorizationSpecs | Nil = nil, fuel : Stripe::FuelSpecs | Nil = nil, is_amount_controllable : Bool | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, network_data : Stripe::NetworkDataSpecs | Nil = nil, verification_data : Stripe::VerificationDataSpecs | Nil = nil, wallet : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Create a test-mode authorization.</p> @required @param amount [Int32?] The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the smallest currency unit. @required @param card [String?] Card associated with this authorization. @optional @param amount_details [Stripe::AmountDetailsSpecs?] @optional @param authorization_method [String?] How the card details were provided. Defaults to online. @optional @param currency [String?] The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param fleet [Stripe::FleetTestmodeAuthorizationSpecs?] @optional @param fuel [Stripe::FuelSpecs?] @optional @param is_amount_controllable [Bool?] If set true, you may provide amount to control how much to hold for the authorization. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param network_data [Stripe::NetworkDataSpecs?] @optional @param verification_data [Stripe::VerificationDataSpecs?] @optional @param wallet [String?] 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. @return nil


[View source]
def post_test_helpers_issuing_authorizations_authorization_capture(*, authorization : String | Nil = nil, capture_amount : Int64 | Nil = nil, close_authorization : Bool | Nil = nil, expand : Array(String) | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Stripe::IssuingAuthorization #

Capture a test-mode authorization.

@required @param authorization [String?] @optional @param capture_amount [Int32?] 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](https://stripe.com/docs/currencies#zero-decimal). @optional @param close_authorization [Bool?] Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return [Stripe::IssuingAuthorization]

[View source]
def post_test_helpers_issuing_authorizations_authorization_capture(*, authorization : String | Nil = nil, capture_amount : Int64 | Nil = nil, close_authorization : Bool | Nil = nil, expand : Array(String) | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Capture a test-mode authorization.</p> @required @param authorization [String?] @optional @param capture_amount [Int32?] 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. @optional @param close_authorization [Bool?] Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return nil


[View source]
def post_test_helpers_issuing_authorizations_authorization_capture_with_http_info(*, authorization : String | Nil = nil, capture_amount : Int64 | Nil = nil, close_authorization : Bool | Nil = nil, expand : Array(String) | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Tuple(Stripe::IssuingAuthorization, Int32, Hash(String, Array(String) | String)) #

<p>Capture a test-mode authorization.</p> @required @param authorization [String?] @optional @param capture_amount [Int32?] 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. @optional @param close_authorization [Bool?] Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return [Tuple(Stripe::IssuingAuthorization, Integer, Hash)] Stripe::IssuingAuthorization, response status code and response headers


[View source]
def post_test_helpers_issuing_authorizations_authorization_expire(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingAuthorization #

Expire a test-mode Authorization.

@required @param authorization [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingAuthorization]

[View source]
def post_test_helpers_issuing_authorizations_authorization_expire(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Expire a test-mode Authorization.</p> @required @param authorization [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_authorizations_authorization_expire_with_http_info(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingAuthorization, Int32, Hash(String, Array(String) | String)) #

<p>Expire a test-mode Authorization.</p> @required @param authorization [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingAuthorization, Integer, Hash)] Stripe::IssuingAuthorization, response status code and response headers


[View source]
def post_test_helpers_issuing_authorizations_authorization_increment(*, authorization : String | Nil = nil, increment_amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, is_amount_controllable : Bool | Nil = nil) : Stripe::IssuingAuthorization #

Increment a test-mode Authorization.

@required @param authorization [String?] @required @param increment_amount [Int32?] The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param is_amount_controllable [Bool?] If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. @return [Stripe::IssuingAuthorization]

[View source]
def post_test_helpers_issuing_authorizations_authorization_increment(*, authorization : String | Nil = nil, increment_amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, is_amount_controllable : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Increment a test-mode Authorization.</p> @required @param authorization [String?] @required @param increment_amount [Int32?] The amount to increment the authorization by. This amount is in the authorization currency and in the smallest currency unit. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param is_amount_controllable [Bool?] If set true, you may provide amount to control how much to hold for the authorization. @return nil


[View source]
def post_test_helpers_issuing_authorizations_authorization_increment_with_http_info(*, authorization : String | Nil = nil, increment_amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, is_amount_controllable : Bool | Nil = nil) : Tuple(Stripe::IssuingAuthorization, Int32, Hash(String, Array(String) | String)) #

<p>Increment a test-mode Authorization.</p> @required @param authorization [String?] @required @param increment_amount [Int32?] The amount to increment the authorization by. This amount is in the authorization currency and in the smallest currency unit. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param is_amount_controllable [Bool?] If set true, you may provide amount to control how much to hold for the authorization. @return [Tuple(Stripe::IssuingAuthorization, Integer, Hash)] Stripe::IssuingAuthorization, response status code and response headers


[View source]
def post_test_helpers_issuing_authorizations_authorization_reverse(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil, reverse_amount : Int64 | Nil = nil) : Stripe::IssuingAuthorization #

Reverse a test-mode Authorization.

@required @param authorization [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param reverse_amount [Int32?] The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @return [Stripe::IssuingAuthorization]

[View source]
def post_test_helpers_issuing_authorizations_authorization_reverse(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil, reverse_amount : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Reverse a test-mode Authorization.</p> @required @param authorization [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param reverse_amount [Int32?] The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the smallest currency unit. @return nil


[View source]
def post_test_helpers_issuing_authorizations_authorization_reverse_with_http_info(*, authorization : String | Nil = nil, expand : Array(String) | Nil = nil, reverse_amount : Int64 | Nil = nil) : Tuple(Stripe::IssuingAuthorization, Int32, Hash(String, Array(String) | String)) #

<p>Reverse a test-mode Authorization.</p> @required @param authorization [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param reverse_amount [Int32?] The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the smallest currency unit. @return [Tuple(Stripe::IssuingAuthorization, Integer, Hash)] Stripe::IssuingAuthorization, response status code and response headers


[View source]
def post_test_helpers_issuing_authorizations_with_http_info(*, amount : Int64 | Nil = nil, card : String | Nil = nil, amount_details : Stripe::AmountDetailsSpecs | Nil = nil, authorization_method : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, fleet : Stripe::FleetTestmodeAuthorizationSpecs | Nil = nil, fuel : Stripe::FuelSpecs | Nil = nil, is_amount_controllable : Bool | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, network_data : Stripe::NetworkDataSpecs | Nil = nil, verification_data : Stripe::VerificationDataSpecs | Nil = nil, wallet : String | Nil = nil) : Tuple(Stripe::IssuingAuthorization, Int32, Hash(String, Array(String) | String)) #

<p>Create a test-mode authorization.</p> @required @param amount [Int32?] The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the smallest currency unit. @required @param card [String?] Card associated with this authorization. @optional @param amount_details [Stripe::AmountDetailsSpecs?] @optional @param authorization_method [String?] How the card details were provided. Defaults to online. @optional @param currency [String?] The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param fleet [Stripe::FleetTestmodeAuthorizationSpecs?] @optional @param fuel [Stripe::FuelSpecs?] @optional @param is_amount_controllable [Bool?] If set true, you may provide amount to control how much to hold for the authorization. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param network_data [Stripe::NetworkDataSpecs?] @optional @param verification_data [Stripe::VerificationDataSpecs?] @optional @param wallet [String?] 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. @return [Tuple(Stripe::IssuingAuthorization, Integer, Hash)] Stripe::IssuingAuthorization, response status code and response headers


[View source]
def post_test_helpers_issuing_cards_card_shipping_fail(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingCard #

Updates the shipping status of the specified Issuing Card object to failure.

@required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingCard]

[View source]
def post_test_helpers_issuing_cards_card_shipping_fail(*, card : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>failure</code>.</p> @required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_cards_card_shipping_fail_with_http_info(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingCard, Int32, Hash(String, Array(String) | String)) #

<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>failure</code>.</p> @required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingCard, Integer, Hash)] Stripe::IssuingCard, response status code and response headers


[View source]
def post_test_helpers_issuing_cards_card_shipping_return(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingCard #

Updates the shipping status of the specified Issuing Card object to returned.

@required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingCard]

[View source]
def post_test_helpers_issuing_cards_card_shipping_return(*, card : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>returned</code>.</p> @required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_cards_card_shipping_return_with_http_info(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingCard, Int32, Hash(String, Array(String) | String)) #

<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>returned</code>.</p> @required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingCard, Integer, Hash)] Stripe::IssuingCard, response status code and response headers


[View source]
def post_test_helpers_issuing_cards_card_shipping_ship(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingCard #

Updates the shipping status of the specified Issuing Card object to shipped.

@required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingCard]

[View source]
def post_test_helpers_issuing_cards_card_shipping_ship(*, card : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>shipped</code>.</p> @required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_cards_card_shipping_ship_with_http_info(*, card : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingCard, Int32, Hash(String, Array(String) | String)) #

<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>shipped</code>.</p> @required @param card [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingCard, Integer, Hash)] Stripe::IssuingCard, response status code and response headers


[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_activate(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingPersonalizationDesign #

Updates the status of the specified testmode personalization design object to active.

@required @param personalization_design [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingPersonalizationDesign]

[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_activate(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>active</code>.</p> @required @param personalization_design [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_activate_with_http_info(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingPersonalizationDesign, Int32, Hash(String, Array(String) | String)) #

<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>active</code>.</p> @required @param personalization_design [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingPersonalizationDesign, Integer, Hash)] Stripe::IssuingPersonalizationDesign, response status code and response headers


[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_deactivate(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingPersonalizationDesign #

Updates the status of the specified testmode personalization design object to inactive.

@required @param personalization_design [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingPersonalizationDesign]

[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_deactivate(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>inactive</code>.</p> @required @param personalization_design [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_deactivate_with_http_info(*, personalization_design : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingPersonalizationDesign, Int32, Hash(String, Array(String) | String)) #

<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>inactive</code>.</p> @required @param personalization_design [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingPersonalizationDesign, Integer, Hash)] Stripe::IssuingPersonalizationDesign, response status code and response headers


[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_reject(*, personalization_design : String | Nil = nil, rejection_reasons : Stripe::RejectionReasonsParam | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::IssuingPersonalizationDesign #

Updates the status of the specified testmode personalization design object to rejected.

@required @param personalization_design [String?] @required @param rejection_reasons [Stripe::RejectionReasonsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::IssuingPersonalizationDesign]

[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_reject(*, personalization_design : String | Nil = nil, rejection_reasons : Stripe::RejectionReasonsParam | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>rejected</code>.</p> @required @param personalization_design [String?] @required @param rejection_reasons [Stripe::RejectionReasonsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_issuing_personalization_designs_personalization_design_reject_with_http_info(*, personalization_design : String | Nil = nil, rejection_reasons : Stripe::RejectionReasonsParam | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::IssuingPersonalizationDesign, Int32, Hash(String, Array(String) | String)) #

<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>rejected</code>.</p> @required @param personalization_design [String?] @required @param rejection_reasons [Stripe::RejectionReasonsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::IssuingPersonalizationDesign, Integer, Hash)] Stripe::IssuingPersonalizationDesign, response status code and response headers


[View source]
def post_test_helpers_issuing_transactions_create_force_capture(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Stripe::IssuingTransaction #

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

@required @param amount [Int32?] The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @required @param card [String?] Card associated with this transaction. @optional @param currency [String?] The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return [Stripe::IssuingTransaction]

[View source]
def post_test_helpers_issuing_transactions_create_force_capture(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Allows the user to capture an arbitrary amount, also known as a forced capture.</p> @required @param amount [Int32?] The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit. @required @param card [String?] Card associated with this transaction. @optional @param currency [String?] The currency of the capture. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return nil


[View source]
def post_test_helpers_issuing_transactions_create_force_capture_with_http_info(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Tuple(Stripe::IssuingTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Allows the user to capture an arbitrary amount, also known as a forced capture.</p> @required @param amount [Int32?] The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit. @required @param card [String?] Card associated with this transaction. @optional @param currency [String?] The currency of the capture. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return [Tuple(Stripe::IssuingTransaction, Integer, Hash)] Stripe::IssuingTransaction, response status code and response headers


[View source]
def post_test_helpers_issuing_transactions_create_unlinked_refund(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Stripe::IssuingTransaction #

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

@required @param amount [Int32?] The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @required @param card [String?] Card associated with this unlinked refund transaction. @optional @param currency [String?] The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return [Stripe::IssuingTransaction]

[View source]
def post_test_helpers_issuing_transactions_create_unlinked_refund(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Allows the user to refund an arbitrary amount, also known as a unlinked refund.</p> @required @param amount [Int32?] The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit. @required @param card [String?] Card associated with this unlinked refund transaction. @optional @param currency [String?] The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return nil


[View source]
def post_test_helpers_issuing_transactions_create_unlinked_refund_with_http_info(*, amount : Int64 | Nil = nil, card : String | Nil = nil, currency : String | Nil = nil, expand : Array(String) | Nil = nil, merchant_data : Stripe::MerchantDataSpecs | Nil = nil, purchase_details : Stripe::PurchaseDetailsSpecs | Nil = nil) : Tuple(Stripe::IssuingTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Allows the user to refund an arbitrary amount, also known as a unlinked refund.</p> @required @param amount [Int32?] The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit. @required @param card [String?] Card associated with this unlinked refund transaction. @optional @param currency [String?] The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param merchant_data [Stripe::MerchantDataSpecs?] @optional @param purchase_details [Stripe::PurchaseDetailsSpecs?] @return [Tuple(Stripe::IssuingTransaction, Integer, Hash)] Stripe::IssuingTransaction, response status code and response headers


[View source]
def post_test_helpers_issuing_transactions_transaction_refund(*, transaction : String | Nil = nil, expand : Array(String) | Nil = nil, refund_amount : Int64 | Nil = nil) : Stripe::IssuingTransaction #

Refund a test-mode Transaction.

@required @param transaction [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param refund_amount [Int32?] The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @return [Stripe::IssuingTransaction]

[View source]
def post_test_helpers_issuing_transactions_transaction_refund(*, transaction : String | Nil = nil, expand : Array(String) | Nil = nil, refund_amount : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Refund a test-mode Transaction.</p> @required @param transaction [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param refund_amount [Int32?] The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit. @return nil


[View source]
def post_test_helpers_issuing_transactions_transaction_refund_with_http_info(*, transaction : String | Nil = nil, expand : Array(String) | Nil = nil, refund_amount : Int64 | Nil = nil) : Tuple(Stripe::IssuingTransaction, Int32, Hash(String, Array(String) | String)) #

<p>Refund a test-mode Transaction.</p> @required @param transaction [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param refund_amount [Int32?] The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit. @return [Tuple(Stripe::IssuingTransaction, Integer, Hash)] Stripe::IssuingTransaction, response status code and response headers


[View source]
def post_test_helpers_terminal_readers_reader_present_payment_method(*, reader : String | Nil = nil, amount_tip : Int64 | Nil = nil, card_present : Stripe::CardPresent | Nil = nil, expand : Array(String) | Nil = nil, interac_present : Stripe::InteracPresent | Nil = nil, _type : String | Nil = nil) : Stripe::TerminalReader #

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

@required @param reader [String?] @optional @param amount_tip [Int32?] Simulated on-reader tip amount. @optional @param card_present [Stripe::CardPresent?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param interac_present [Stripe::InteracPresent?] @optional @param _type [String?] Simulated payment type. @return [Stripe::TerminalReader]

[View source]
def post_test_helpers_terminal_readers_reader_present_payment_method(*, reader : String | Nil = nil, amount_tip : Int64 | Nil = nil, card_present : Stripe::CardPresent | Nil = nil, expand : Array(String) | Nil = nil, interac_present : Stripe::InteracPresent | Nil = nil, _type : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.</p> @required @param reader [String?] @optional @param amount_tip [Int32?] Simulated on-reader tip amount. @optional @param card_present [Stripe::CardPresent?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param interac_present [Stripe::InteracPresent?] @optional @param _type [String?] Simulated payment type. @return nil


[View source]
def post_test_helpers_terminal_readers_reader_present_payment_method_with_http_info(*, reader : String | Nil = nil, amount_tip : Int64 | Nil = nil, card_present : Stripe::CardPresent | Nil = nil, expand : Array(String) | Nil = nil, interac_present : Stripe::InteracPresent | Nil = nil, _type : String | Nil = nil) : Tuple(Stripe::TerminalReader, Int32, Hash(String, Array(String) | String)) #

<p>Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.</p> @required @param reader [String?] @optional @param amount_tip [Int32?] Simulated on-reader tip amount. @optional @param card_present [Stripe::CardPresent?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param interac_present [Stripe::InteracPresent?] @optional @param _type [String?] Simulated payment type. @return [Tuple(Stripe::TerminalReader, Integer, Hash)] Stripe::TerminalReader, response status code and response headers


[View source]
def post_test_helpers_test_clocks(*, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil) : Stripe::TestHelpersTestClock #

Creates a new test clock that can be attached to new customers and quotes.

@required @param frozen_time [Int32?] The initial frozen time for this test clock. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] The name for this test clock. @return [Stripe::TestHelpersTestClock]

[View source]
def post_test_helpers_test_clocks(*, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a new test clock that can be attached to new customers and quotes.</p> @required @param frozen_time [Int32?] The initial frozen time for this test clock. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] The name for this test clock. @return nil


[View source]
def post_test_helpers_test_clocks_test_clock_advance(*, test_clock : String | Nil = nil, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TestHelpersTestClock #

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

@required @param test_clock [String?] @required @param frozen_time [Int32?] The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TestHelpersTestClock]

[View source]
def post_test_helpers_test_clocks_test_clock_advance(*, test_clock : String | Nil = nil, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to <code>Ready</code>.</p> @required @param test_clock [String?] @required @param frozen_time [Int32?] The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_test_clocks_test_clock_advance_with_http_info(*, test_clock : String | Nil = nil, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TestHelpersTestClock, Int32, Hash(String, Array(String) | String)) #

<p>Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to <code>Ready</code>.</p> @required @param test_clock [String?] @required @param frozen_time [Int32?] The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TestHelpersTestClock, Integer, Hash)] Stripe::TestHelpersTestClock, response status code and response headers


[View source]
def post_test_helpers_test_clocks_with_http_info(*, frozen_time : Int64 | Nil = nil, expand : Array(String) | Nil = nil, name : String | Nil = nil) : Tuple(Stripe::TestHelpersTestClock, Int32, Hash(String, Array(String) | String)) #

<p>Creates a new test clock that can be attached to new customers and quotes.</p> @required @param frozen_time [Int32?] The initial frozen time for this test clock. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param name [String?] The name for this test clock. @return [Tuple(Stripe::TestHelpersTestClock, Integer, Hash)] Stripe::TestHelpersTestClock, response status code and response headers


[View source]
def post_test_helpers_treasury_inbound_transfers_id_fail(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, failure_details : Stripe::FailureDetailsParams | Nil = nil) : Stripe::TreasuryInboundTransfer #

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

@required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param failure_details [Stripe::FailureDetailsParams?] @return [Stripe::TreasuryInboundTransfer]

[View source]
def post_test_helpers_treasury_inbound_transfers_id_fail(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, failure_details : Stripe::FailureDetailsParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created InboundTransfer to the <code>failed</code> status. The InboundTransfer must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param failure_details [Stripe::FailureDetailsParams?] @return nil


[View source]
def post_test_helpers_treasury_inbound_transfers_id_fail_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, failure_details : Stripe::FailureDetailsParams | Nil = nil) : Tuple(Stripe::TreasuryInboundTransfer, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created InboundTransfer to the <code>failed</code> status. The InboundTransfer must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param failure_details [Stripe::FailureDetailsParams?] @return [Tuple(Stripe::TreasuryInboundTransfer, Integer, Hash)] Stripe::TreasuryInboundTransfer, response status code and response headers


[View source]
def post_test_helpers_treasury_inbound_transfers_id_succeed(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TreasuryInboundTransfer #

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

@required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TreasuryInboundTransfer]

[View source]
def post_test_helpers_treasury_inbound_transfers_id_succeed(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created InboundTransfer to the <code>succeeded</code> status. The InboundTransfer must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_treasury_inbound_transfers_id_succeed_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TreasuryInboundTransfer, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created InboundTransfer to the <code>succeeded</code> status. The InboundTransfer must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TreasuryInboundTransfer, Integer, Hash)] Stripe::TreasuryInboundTransfer, response status code and response headers


[View source]
def post_test_helpers_treasury_outbound_payments_id_fail(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TreasuryOutboundPayment #

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

@required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TreasuryOutboundPayment]

[View source]
def post_test_helpers_treasury_outbound_payments_id_fail(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created OutboundPayment to the <code>failed</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_treasury_outbound_payments_id_fail_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TreasuryOutboundPayment, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created OutboundPayment to the <code>failed</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TreasuryOutboundPayment, Integer, Hash)] Stripe::TreasuryOutboundPayment, response status code and response headers


[View source]
def post_test_helpers_treasury_outbound_payments_id_post(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TreasuryOutboundPayment #

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

@required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TreasuryOutboundPayment]

[View source]
def post_test_helpers_treasury_outbound_payments_id_post(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created OutboundPayment to the <code>posted</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_treasury_outbound_payments_id_post_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TreasuryOutboundPayment, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created OutboundPayment to the <code>posted</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TreasuryOutboundPayment, Integer, Hash)] Stripe::TreasuryOutboundPayment, response status code and response headers


[View source]
def post_test_helpers_treasury_outbound_payments_id_return(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil) : Stripe::TreasuryOutboundPayment #

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

@required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param returned_details [Stripe::ReturnedDetailsParams?] @return [Stripe::TreasuryOutboundPayment]

[View source]
def post_test_helpers_treasury_outbound_payments_id_return(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created OutboundPayment to the <code>returned</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param returned_details [Stripe::ReturnedDetailsParams?] @return nil


[View source]
def post_test_helpers_treasury_outbound_payments_id_return_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil) : Tuple(Stripe::TreasuryOutboundPayment, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created OutboundPayment to the <code>returned</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p> @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param returned_details [Stripe::ReturnedDetailsParams?] @return [Tuple(Stripe::TreasuryOutboundPayment, Integer, Hash)] Stripe::TreasuryOutboundPayment, response status code and response headers


[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_fail(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TreasuryOutboundTransfer #

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

@required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TreasuryOutboundTransfer]

[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_fail(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created OutboundTransfer to the <code>failed</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p> @required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_fail_with_http_info(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TreasuryOutboundTransfer, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created OutboundTransfer to the <code>failed</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p> @required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TreasuryOutboundTransfer, Integer, Hash)] Stripe::TreasuryOutboundTransfer, response status code and response headers


[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_post(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::TreasuryOutboundTransfer #

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

@required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::TreasuryOutboundTransfer]

[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_post(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created OutboundTransfer to the <code>posted</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p> @required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_post_with_http_info(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::TreasuryOutboundTransfer, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created OutboundTransfer to the <code>posted</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p> @required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TreasuryOutboundTransfer, Integer, Hash)] Stripe::TreasuryOutboundTransfer, response status code and response headers


[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_return(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil) : Stripe::TreasuryOutboundTransfer #

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

@required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param returned_details [Stripe::ReturnedDetailsParams?] @return [Stripe::TreasuryOutboundTransfer]

[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_return(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Transitions a test mode created OutboundTransfer to the <code>returned</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p> @required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param returned_details [Stripe::ReturnedDetailsParams?] @return nil


[View source]
def post_test_helpers_treasury_outbound_transfers_outbound_transfer_return_with_http_info(*, outbound_transfer : String | Nil = nil, expand : Array(String) | Nil = nil, returned_details : Stripe::ReturnedDetailsParams | Nil = nil) : Tuple(Stripe::TreasuryOutboundTransfer, Int32, Hash(String, Array(String) | String)) #

<p>Transitions a test mode created OutboundTransfer to the <code>returned</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p> @required @param outbound_transfer [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param returned_details [Stripe::ReturnedDetailsParams?] @return [Tuple(Stripe::TreasuryOutboundTransfer, Integer, Hash)] Stripe::TreasuryOutboundTransfer, response status code and response headers


[View source]
def post_test_helpers_treasury_received_credits(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil) : Stripe::TreasuryReceivedCredit #

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.

@required @param amount [Int32?] Amount (in cents) to be transferred. @required @param currency [String?] Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @required @param financial_account [String?] The FinancialAccount to send funds to. @required @param network [String?] Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param initiating_payment_method_details [Stripe::SourceParams?] @return [Stripe::TreasuryReceivedCredit]

[View source]
def post_test_helpers_treasury_received_credits(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>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.</p> @required @param amount [Int32?] Amount (in cents) to be transferred. @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @required @param financial_account [String?] The FinancialAccount to send funds to. @required @param network [String?] Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the docs to learn more about money movement timelines for each network type. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param initiating_payment_method_details [Stripe::SourceParams?] @return nil


[View source]
def post_test_helpers_treasury_received_credits_with_http_info(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil) : Tuple(Stripe::TreasuryReceivedCredit, Int32, Hash(String, Array(String) | String)) #

<p>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.</p> @required @param amount [Int32?] Amount (in cents) to be transferred. @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @required @param financial_account [String?] The FinancialAccount to send funds to. @required @param network [String?] Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the docs to learn more about money movement timelines for each network type. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param initiating_payment_method_details [Stripe::SourceParams?] @return [Tuple(Stripe::TreasuryReceivedCredit, Integer, Hash)] Stripe::TreasuryReceivedCredit, response status code and response headers


[View source]
def post_test_helpers_treasury_received_debits(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil) : Stripe::TreasuryReceivedDebit #

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

@required @param amount [Int32?] Amount (in cents) to be transferred. @required @param currency [String?] Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @required @param financial_account [String?] The FinancialAccount to pull funds from. @required @param network [String?] Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param initiating_payment_method_details [Stripe::SourceParams?] @return [Stripe::TreasuryReceivedDebit]

[View source]
def post_test_helpers_treasury_received_debits(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.</p> @required @param amount [Int32?] Amount (in cents) to be transferred. @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @required @param financial_account [String?] The FinancialAccount to pull funds from. @required @param network [String?] Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the docs to learn more about money movement timelines for each network type. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param initiating_payment_method_details [Stripe::SourceParams?] @return nil


[View source]
def post_test_helpers_treasury_received_debits_with_http_info(*, amount : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, network : String | Nil = nil, description : String | Nil = nil, expand : Array(String) | Nil = nil, initiating_payment_method_details : Stripe::SourceParams | Nil = nil) : Tuple(Stripe::TreasuryReceivedDebit, Int32, Hash(String, Array(String) | String)) #

<p>Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.</p> @required @param amount [Int32?] Amount (in cents) to be transferred. @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @required @param financial_account [String?] The FinancialAccount to pull funds from. @required @param network [String?] Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the docs to learn more about money movement timelines for each network type. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param initiating_payment_method_details [Stripe::SourceParams?] @return [Tuple(Stripe::TreasuryReceivedDebit, Integer, Hash)] Stripe::TreasuryReceivedDebit, response status code and response headers


[View source]