class

Plaid::TransferRefundCreateRequest

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

Defines the request schema for /transfer/refund/create

Constants

MAX_LENGTH_FOR_IDEMPOTENCY_KEY = 50

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, transfer_id : String | Nil = nil, amount : String | Nil = nil, idempotency_key : String | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil)

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

Source

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

amount

The amount of the refund (decimal string with two digits of precision e.g. "10.00").

Source
amount=(new_value : String | Nil)

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

Source
client_id

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

Source
client_id=(new_value : String | Nil)

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

Source
hash(hasher)

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

idempotency_key

A random key provided by the client, per unique refund. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a refund fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single refund is created.

Source
idempotency_key=(new_value : String | Nil)

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

Source
list_invalid_properties

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

Source
secret

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Source
secret=(new_value : String | Nil)

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

Source
transfer_id

The ID of the transfer to refund.

Source
transfer_id=(new_value : String | Nil)

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

Source
valid?

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

Source