Class SourceCreateParams


public class SourceCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static SourceCreateParams.Builder builder()
    • getAmount

      public Long getAmount()
      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.
    • getCurrency

      public String getCurrency()
      Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready.
    • getCustomer

      public String getCustomer()
      The Customer to whom the original source is attached to. Must be set when the original source is not a Source (e.g., Card).
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getFlow

      public SourceCreateParams.Flow getFlow()
      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.
    • getMandate

      public SourceCreateParams.Mandate getMandate()
      Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    • getMetadata

      public Map<String,String> getMetadata()
    • getOriginalSource

      public String getOriginalSource()
      The source to share.
    • getOwner

      public SourceCreateParams.Owner getOwner()
      Information about the owner of the payment instrument that may be used or required by particular source types.
    • getReceiver

      public SourceCreateParams.Receiver getReceiver()
      Optional parameters for the receiver flow. Can be set only if the source is a receiver ( flow is receiver).
    • getRedirect

      public SourceCreateParams.Redirect getRedirect()
      Parameters required for the redirect flow. Required if the source is authenticated by a redirect (flow is redirect).
    • getSourceOrder

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

      public String getStatementDescriptor()
      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.
    • getToken

      public String getToken()
      An optional token used to create the source. When passed, token properties will override source parameters.
    • getType

      public String getType()
      The type of the source to create. Required unless customer and original_source are specified (see the Cloning card Sources guide)
    • getUsage

      public SourceCreateParams.Usage getUsage()