Class: Stripe::SourceService::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/source_service.rb

Defined Under Namespace

Classes: Mandate, Owner, Receiver, Redirect, SourceOrder

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, currency: nil, customer: nil, expand: nil, flow: nil, mandate: nil, metadata: nil, original_source: nil, owner: nil, receiver: nil, redirect: nil, source_order: nil, statement_descriptor: nil, token: nil, type: nil, usage: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/stripe/services/source_service.rb', line 565

def initialize(
  amount: nil,
  currency: nil,
  customer: nil,
  expand: nil,
  flow: nil,
  mandate: nil,
  metadata: nil,
  original_source: nil,
  owner: nil,
  receiver: nil,
  redirect: nil,
  source_order: nil,
  statement_descriptor: nil,
  token: nil,
  type: nil,
  usage: nil
)
  @amount = amount
  @currency = currency
  @customer = customer
  @expand = expand
  @flow = flow
  @mandate = mandate
  @metadata = metadata
  @original_source = original_source
  @owner = owner
  @receiver = receiver
  @redirect = redirect
  @source_order = source_order
  @statement_descriptor = statement_descriptor
  @token = token
  @type = type
  @usage = usage
end

Instance Attribute Details

#amount ⇒ Object

Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for ‘single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.



533
534
535
 
# File 'lib/stripe/services/source_service.rb', line 533

def amount
  @amount
end

#currency ⇒ Object

Three-letter [ISO code for the currency](stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.



535
536
537
 
# File 'lib/stripe/services/source_service.rb', line 535

def currency
  @currency
end

#customer ⇒ Object

The ‘Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).



537
538
539
 
# File 'lib/stripe/services/source_service.rb', line 537

def customer
  @customer
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



539
540
541
 
# File 'lib/stripe/services/source_service.rb', line 539

def expand
  @expand
end

#flow ⇒ Object

The authentication ‘flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.



541
542
543
 
# File 'lib/stripe/services/source_service.rb', line 541

def flow
  @flow
end

#mandate ⇒ Object

Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.



543
544
545
 
# File 'lib/stripe/services/source_service.rb', line 543

def mandate
  @mandate
end

#metadata ⇒ Object

Attribute for param field metadata



545
546
547
 
# File 'lib/stripe/services/source_service.rb', line 545

def metadata
  @metadata
end

#original_source ⇒ Object

The source to share.



547
548
549
 
# File 'lib/stripe/services/source_service.rb', line 547

def original_source
  @original_source
end

#owner ⇒ Object

Information about the owner of the payment instrument that may be used or required by particular source types.



549
550
551
 
# File 'lib/stripe/services/source_service.rb', line 549

def owner
  @owner
end

#receiver ⇒ Object

Optional parameters for the receiver flow. Can be set only if the source is a receiver (‘flow` is `receiver`).



551
552
553
 
# File 'lib/stripe/services/source_service.rb', line 551

def receiver
  @receiver
end

#redirect ⇒ Object

Parameters required for the redirect flow. Required if the source is authenticated by a redirect (‘flow` is `redirect`).



553
554
555
 
# File 'lib/stripe/services/source_service.rb', line 553

def redirect
  @redirect
end

#source_order ⇒ Object

Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.



555
556
557
 
# File 'lib/stripe/services/source_service.rb', line 555

def source_order
  @source_order
end

#statement_descriptor ⇒ Object

An arbitrary string to be displayed on your customer’s statement. As an example, if your website is ‘RunClub` and the item you’re charging for is a race ticket, you may want to specify a ‘statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.



557
558
559
 
# File 'lib/stripe/services/source_service.rb', line 557

def statement_descriptor
  @statement_descriptor
end

#token ⇒ Object

An optional token used to create the source. When passed, token properties will override source parameters.



559
560
561
 
# File 'lib/stripe/services/source_service.rb', line 559

def token
  @token
end

#type ⇒ Object

The ‘type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](stripe.com/docs/sources/connect#cloning-card-sources) guide)



561
562
563
 
# File 'lib/stripe/services/source_service.rb', line 561

def type
  @type
end

#usage ⇒ Object

Attribute for param field usage



563
564
565
 
# File 'lib/stripe/services/source_service.rb', line 563

def usage
  @usage
end