class

Stripe::ForwardingRequest

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request. Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period. You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request. Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits. Related guide: Forward card details to third-party API endpoints.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [forwarding.request]."

ERROR_MESSAGE_FOR_REPLACEMENTS = "invalid value for \"replacements\", must be one of [card_cvc, card_expiry, card_number, cardholder_name]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_PAYMENT_METHOD = 5000

MAX_LENGTH_FOR_URL = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("forwarding.request")

VALID_VALUES_FOR_REPLACEMENTS = String.static_array("card_cvc", "card_expiry", "card_number", "cardholder_name")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, created : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, payment_method : String | Nil = nil, replacements : Array(String) | Nil = nil, request_context : Stripe::ForwardingRequestRequestContext | Nil = nil, request_details : Stripe::ForwardingRequestRequestDetails | Nil = nil, response_details : Stripe::ForwardingRequestResponseDetails | Nil = nil, url : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

created

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

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

object

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

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

payment_method

The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.

payment_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_method Object to be assigned

replacements

The field kinds to be replaced in the forwarded request.

replacements=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] replacements Object to be assigned

request_context

request_context=(new_value : Stripe::ForwardingRequestRequestContext | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_context Object to be assigned

request_details

request_details=(new_value : Stripe::ForwardingRequestRequestDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_details Object to be assigned

response_details

response_details=(new_value : Stripe::ForwardingRequestResponseDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] response_details Object to be assigned

url

The destination URL for the forwarded request. Must be supported by the config.

url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] url Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid