Class: Stripe::Issuing::CardholderService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/issuing/cardholder_service.rb

Defined Under Namespace

Classes: CreateParams, ListParams, RetrieveParams, UpdateParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#create(params = {}, opts = {}) ⇒ Object

Creates a new Issuing Cardholder object that can be issued cards.



533
534
535
536
537
538
539
540
541
# File 'lib/stripe/services/issuing/cardholder_service.rb', line 533

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/issuing/cardholders",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.



544
545
546
547
548
549
550
551
552
# File 'lib/stripe/services/issuing/cardholder_service.rb', line 544

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/issuing/cardholders",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(cardholder, params = {}, opts = {}) ⇒ Object

Retrieves an Issuing Cardholder object.



555
556
557
558
559
560
561
562
563
# File 'lib/stripe/services/issuing/cardholder_service.rb', line 555

def retrieve(cardholder, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/issuing/cardholders/%<cardholder>s", { cardholder: CGI.escape(cardholder) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(cardholder, params = {}, opts = {}) ⇒ Object

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



566
567
568
569
570
571
572
573
574
# File 'lib/stripe/services/issuing/cardholder_service.rb', line 566

def update(cardholder, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/issuing/cardholders/%<cardholder>s", { cardholder: CGI.escape(cardholder) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end