Class: Stripe::Source

Inherits:
APIResource show all
Extended by:
Gem::Deprecate, APIOperations::Create, APIOperations::NestedResource
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/source.rb

Overview

‘Source` objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like a ‘Card` object: once chargeable, they can be charged, or can be attached to customers.

Stripe doesn’t recommend using the deprecated [Sources API](stripe.com/docs/api/sources). We recommend that you adopt the [PaymentMethods API](stripe.com/docs/api/payment_methods). This newer API provides access to our latest features and payment method types.

Related guides: [Sources API](stripe.com/docs/sources) and [Sources & Customers](stripe.com/docs/sources/customers).

Defined Under Namespace

Classes: AchCreditTransfer, AchDebit, AcssDebit, Alipay, AuBecsDebit, Bancontact, Card, CardPresent, CodeVerification, Eps, Giropay, Ideal, Klarna, Multibanco, Owner, P24, Receiver, Redirect, SepaCreditTransfer, SepaDebit, Sofort, SourceOrder, ThreeDSecure, Wechat

Constant Summary collapse

OBJECT_NAME = 
"source"

Constants inherited from StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::NestedResource

nested_resource_class_methods

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#ach_credit_transfer ⇒ Object (readonly)

Attribute for field ach_credit_transfer



799
800
801
 
# File 'lib/stripe/resources/source.rb', line 799

def ach_credit_transfer
  @ach_credit_transfer
end

#ach_debit ⇒ Object (readonly)

Attribute for field ach_debit



801
802
803
 
# File 'lib/stripe/resources/source.rb', line 801

def ach_debit
  @ach_debit
end

#acss_debit ⇒ Object (readonly)

Attribute for field acss_debit



803
804
805
 
# File 'lib/stripe/resources/source.rb', line 803

def acss_debit
  @acss_debit
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



805
806
807
 
# File 'lib/stripe/resources/source.rb', line 805

def alipay
  @alipay
end

#allow_redisplay ⇒ Object (readonly)

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.



807
808
809
 
# File 'lib/stripe/resources/source.rb', line 807

def allow_redisplay
  @allow_redisplay
end

#amount ⇒ Object (readonly)

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for ‘single_use` sources.



809
810
811
 
# File 'lib/stripe/resources/source.rb', line 809

def amount
  @amount
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



811
812
813
 
# File 'lib/stripe/resources/source.rb', line 811

def au_becs_debit
  @au_becs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



813
814
815
 
# File 'lib/stripe/resources/source.rb', line 813

def bancontact
  @bancontact
end

#card ⇒ Object (readonly)

Attribute for field card



815
816
817
 
# File 'lib/stripe/resources/source.rb', line 815

def card
  @card
end

#card_present ⇒ Object (readonly)

Attribute for field card_present



817
818
819
 
# File 'lib/stripe/resources/source.rb', line 817

def card_present
  @card_present
end

#client_secret ⇒ Object (readonly)

The client secret of the source. Used for client-side retrieval using a publishable key.



819
820
821
 
# File 'lib/stripe/resources/source.rb', line 819

def client_secret
  @client_secret
end

#code_verification ⇒ Object (readonly)

Attribute for field code_verification



821
822
823
 
# File 'lib/stripe/resources/source.rb', line 821

def code_verification
  @code_verification
end

#created ⇒ Object (readonly)

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



823
824
825
 
# File 'lib/stripe/resources/source.rb', line 823

def created
  @created
end

#currency ⇒ Object (readonly)

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. Required for ‘single_use` sources.



825
826
827
 
# File 'lib/stripe/resources/source.rb', line 825

def currency
  @currency
end

#customer ⇒ Object (readonly)

The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.



827
828
829
 
# File 'lib/stripe/resources/source.rb', line 827

def customer
  @customer
end

#eps ⇒ Object (readonly)

Attribute for field eps



829
830
831
 
# File 'lib/stripe/resources/source.rb', line 829

def eps
  @eps
end

#flow ⇒ Object (readonly)

The authentication ‘flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.



831
832
833
 
# File 'lib/stripe/resources/source.rb', line 831

def flow
  @flow
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



833
834
835
 
# File 'lib/stripe/resources/source.rb', line 833

def giropay
  @giropay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



835
836
837
 
# File 'lib/stripe/resources/source.rb', line 835

def id
  @id
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



837
838
839
 
# File 'lib/stripe/resources/source.rb', line 837

def ideal
  @ideal
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



839
840
841
 
# File 'lib/stripe/resources/source.rb', line 839

def klarna
  @klarna
end

#livemode ⇒ Object (readonly)

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



841
842
843
 
# File 'lib/stripe/resources/source.rb', line 841

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



843
844
845
 
# File 'lib/stripe/resources/source.rb', line 843

def metadata
  @metadata
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



845
846
847
 
# File 'lib/stripe/resources/source.rb', line 845

def multibanco
  @multibanco
end

#object ⇒ Object (readonly)

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



847
848
849
 
# File 'lib/stripe/resources/source.rb', line 847

def object
  @object
end

#owner ⇒ Object (readonly)

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



849
850
851
 
# File 'lib/stripe/resources/source.rb', line 849

def owner
  @owner
end

#p24 ⇒ Object (readonly)

Attribute for field p24



851
852
853
 
# File 'lib/stripe/resources/source.rb', line 851

def p24
  @p24
end

#receiver ⇒ Object (readonly)

Attribute for field receiver



853
854
855
 
# File 'lib/stripe/resources/source.rb', line 853

def receiver
  @receiver
end

#redirect ⇒ Object (readonly)

Attribute for field redirect



855
856
857
 
# File 'lib/stripe/resources/source.rb', line 855

def redirect
  @redirect
end

#sepa_credit_transfer ⇒ Object (readonly)

Attribute for field sepa_credit_transfer



857
858
859
 
# File 'lib/stripe/resources/source.rb', line 857

def sepa_credit_transfer
  @sepa_credit_transfer
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



859
860
861
 
# File 'lib/stripe/resources/source.rb', line 859

def sepa_debit
  @sepa_debit
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



861
862
863
 
# File 'lib/stripe/resources/source.rb', line 861

def sofort
  @sofort
end

#source_order ⇒ Object (readonly)

Attribute for field source_order



863
864
865
 
# File 'lib/stripe/resources/source.rb', line 863

def source_order
  @source_order
end

#statement_descriptor ⇒ Object (readonly)

Extra information about a source. This will appear on your customer’s statement every time you charge the source.



865
866
867
 
# File 'lib/stripe/resources/source.rb', line 865

def statement_descriptor
  @statement_descriptor
end

#status ⇒ Object (readonly)

The status of the source, one of ‘canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.



867
868
869
 
# File 'lib/stripe/resources/source.rb', line 867

def status
  @status
end

#three_d_secure ⇒ Object (readonly)

Attribute for field three_d_secure



869
870
871
 
# File 'lib/stripe/resources/source.rb', line 869

def three_d_secure
  @three_d_secure
end

#type ⇒ Object (readonly)

The ‘type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](stripe.com/docs/sources) used.



871
872
873
 
# File 'lib/stripe/resources/source.rb', line 871

def type
  @type
end

#usage ⇒ Object (readonly)

Either ‘reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.



873
874
875
 
# File 'lib/stripe/resources/source.rb', line 873

def usage
  @usage
end

#wechat ⇒ Object (readonly)

Attribute for field wechat



875
876
877
 
# File 'lib/stripe/resources/source.rb', line 875

def wechat
  @wechat
end

Class Method Details

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

Creates a new source object.



878
879
880
 
# File 'lib/stripe/resources/source.rb', line 878

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/sources", params: params, opts: opts)
end

.field_remappings ⇒ Object 



968
969
970
 
# File 'lib/stripe/resources/source.rb', line 968

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/stripe/resources/source.rb', line 939

def self.inner_class_types
  @inner_class_types = {
    ach_credit_transfer: AchCreditTransfer,
    ach_debit: AchDebit,
    acss_debit: AcssDebit,
    alipay: Alipay,
    au_becs_debit: AuBecsDebit,
    bancontact: Bancontact,
    card: Card,
    card_present: CardPresent,
    code_verification: CodeVerification,
    eps: Eps,
    giropay: Giropay,
    ideal: Ideal,
    klarna: Klarna,
    multibanco: Multibanco,
    owner: Owner,
    p24: P24,
    receiver: Receiver,
    redirect: Redirect,
    sepa_credit_transfer: SepaCreditTransfer,
    sepa_debit: SepaDebit,
    sofort: Sofort,
    source_order: SourceOrder,
    three_d_secure: ThreeDSecure,
    wechat: Wechat,
  }
end

.object_name ⇒ Object 



21
22
23
 
# File 'lib/stripe/resources/source.rb', line 21

def self.object_name
  "source"
end

.update(source, params = {}, opts = {}) ⇒ Object

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

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](docs.stripe.com/docs/sources) for more detail.



885
886
887
888
889
890
891
892
 
# File 'lib/stripe/resources/source.rb', line 885

def self.update(source, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/sources/%<source>s", { source: CGI.escape(source) }),
    params: params,
    opts: opts
  )
end

.verify(source, params = {}, opts = {}) ⇒ Object

Verify a given source.



905
906
907
908
909
910
911
912
 
# File 'lib/stripe/resources/source.rb', line 905

def self.verify(source, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/sources/%<source>s/verify", { source: CGI.escape(source) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

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



914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/stripe/resources/source.rb', line 914

def detach(params = {}, opts = {})
  if !respond_to?(:customer) || customer.nil? || customer.empty?
    raise NotImplementedError,
          "This source object does not appear to be currently attached " \
          "to a customer object."
  end

  url = "#{Customer.resource_url}/#{CGI.escape(customer)}/sources" \
        "/#{CGI.escape(id)}"
  opts = Util.normalize_opts(opts)
  APIRequestor.active_requestor.execute_request_initialize_from(:delete, url, :api, self,
                                                                params: params, opts: RequestOptions.extract_opts_from_hash(opts))
end

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



928
929
930
931
932
933
934
935
 
# File 'lib/stripe/resources/source.rb', line 928

def source_transactions(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: resource_url + "/source_transactions",
    params: params,
    opts: opts
  )
end

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

Verify a given source.



895
896
897
898
899
900
901
902
 
# File 'lib/stripe/resources/source.rb', line 895

def verify(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/sources/%<source>s/verify", { source: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end