Class OutboundPaymentCreateParams


public class OutboundPaymentCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static OutboundPaymentCreateParams.Builder builder()
    • getAmount

      public Long getAmount()
      Required. Amount (in cents) to be transferred.
    • getCurrency

      public String getCurrency()
      Required. Three-letter ISO currency code, in lowercase. Must be a supported currency.
    • getCustomer

      public String getCustomer()
      ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in.
    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.
    • getDestinationPaymentMethod

      public String getDestinationPaymentMethod()
      The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with destination_payment_method_data.
    • getDestinationPaymentMethodData

      public OutboundPaymentCreateParams.DestinationPaymentMethodData getDestinationPaymentMethodData()
      Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.
    • getDestinationPaymentMethodOptions

      public OutboundPaymentCreateParams.DestinationPaymentMethodOptions getDestinationPaymentMethodOptions()
      Payment method-specific configuration for this OutboundPayment.
    • getEndUserDetails

      public OutboundPaymentCreateParams.EndUserDetails getEndUserDetails()
      End user details.
    • 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.
    • getFinancialAccount

      public String getFinancialAccount()
      Required. The FinancialAccount to pull funds from.
    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    • getStatementDescriptor

      public String getStatementDescriptor()
      The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. The default value is "payment".