class Stripe::ForwardingRequest

Overview

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.

Included Modules

Defined in:

stripe/models/forwarding_request.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def payment_method : String | Nil #

[View source]
def payment_method=(new_value : String | Nil) #

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


[View source]
def replacements : Array(String) | Nil #

[View source]
def replacements=(new_value : Array(String) | Nil) #

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


[View source]
def request_context : Stripe::ForwardingRequestRequestContext | Nil #

[View source]
def request_context=(new_value : Stripe::ForwardingRequestRequestContext | Nil) #

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


[View source]
def request_details : Stripe::ForwardingRequestRequestDetails | Nil #

[View source]
def request_details=(new_value : Stripe::ForwardingRequestRequestDetails | Nil) #

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


[View source]
def response_details : Stripe::ForwardingRequestResponseDetails | Nil #

[View source]
def response_details=(new_value : Stripe::ForwardingRequestResponseDetails | Nil) #

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


[View source]
def url : String | Nil #

[View source]
def url=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]