Package model

Class Transfer

java.lang.Object
model.Transfer
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]") public class Transfer extends Object

  • Field Details

  • Constructor Details

    • Transfer

      public Transfer()

  • Method Details

    • tags

      public Transfer tags(Map<String,String> tags)

    • putTagsItem

      public Transfer putTagsItem(String key, String tagsItem)

    • getTags

      @Nullable public Map<String,String> getTags()
      Key value pair for annotating custom meta data (e.g. order numbers).
      Returns:
      tags

    • setTags

      public void setTags(Map<String,String> tags)

    • type

      public Transfer type(Transfer.TypeEnum type)

    • getType

      @Nullable public Transfer.TypeEnum getType()
      Type of `Transfer`.
      Returns:
      type

    • setType

      public void setType(Transfer.TypeEnum type)

    • id

      public Transfer id(String id)

    • getId

      @Nullable public String getId()
      The ID of the `Transfer` resource.
      Returns:
      id

    • setId

      public void setId(String id)

    • createdAt

      public Transfer createdAt(OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Timestamp of when the object was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(OffsetDateTime createdAt)

    • updatedAt

      public Transfer updatedAt(OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Timestamp of when the object was last updated.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(OffsetDateTime updatedAt)

    • amount

      public Transfer amount(Long amount)

    • getAmount

      @Nullable public Long getAmount()
      The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
      Returns:
      amount

    • setAmount

      public void setAmount(Long amount)

    • application

      public Transfer application(String application)

    • getApplication

      @Nullable public String getApplication()
      The ID of the resource.
      Returns:
      application

    • setApplication

      public void setApplication(String application)

    • cardPresentDetails

      public Transfer cardPresentDetails(CardPresentDetails cardPresentDetails)

    • getCardPresentDetails

      @Nullable public CardPresentDetails getCardPresentDetails()
      Get cardPresentDetails
      Returns:
      cardPresentDetails

    • setCardPresentDetails

      public void setCardPresentDetails(CardPresentDetails cardPresentDetails)

    • currency

      public Transfer currency(Currency currency)

    • getCurrency

      @Nullable public Currency getCurrency()
      Get currency
      Returns:
      currency

    • setCurrency

      public void setCurrency(Currency currency)

    • destination

      public Transfer destination(String destination)

    • getDestination

      @Nullable public String getDestination()
      The ID of the destination.
      Returns:
      destination

    • setDestination

      public void setDestination(String destination)

    • device

      public Transfer device(String device)

    • getDevice

      @Nullable public String getDevice()
      The ID of the resource.
      Returns:
      device

    • setDevice

      public void setDevice(String device)

    • fee

      public Transfer fee(Long fee)

    • getFee

      @Nullable public Long getFee()
      The amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).
      Returns:
      fee

    • setFee

      public void setFee(Long fee)

    • feeType

      public Transfer feeType(FeeType feeType)

    • getFeeType

      @Nullable public FeeType getFeeType()
      Get feeType
      Returns:
      feeType

    • setFeeType

      public void setFeeType(FeeType feeType)

    • idempotencyId

      public Transfer idempotencyId(String idempotencyId)

    • getIdempotencyId

      @Nullable public String getIdempotencyId()
      ID to [idempotently](#section/Idempotency-Requests) identifty the transfer.
      Returns:
      idempotencyId

    • setIdempotencyId

      public void setIdempotencyId(String idempotencyId)

    • identity

      public Transfer identity(String identity)

    • getIdentity

      @Nullable public String getIdentity()
      The ID of the identity.
      Returns:
      identity

    • setIdentity

      public void setIdentity(String identity)

    • merchantIdentity

      public Transfer merchantIdentity(String merchantIdentity)

    • getMerchantIdentity

      @Nullable public String getMerchantIdentity()
      The ID of the resource.
      Returns:
      merchantIdentity

    • setMerchantIdentity

      public void setMerchantIdentity(String merchantIdentity)

    • messages

      public Transfer messages(List<String> messages)

    • addMessagesItem

      public Transfer addMessagesItem(String messagesItem)

    • getMessages

      @Nullable public List<String> getMessages()
      Get messages
      Returns:
      messages

    • setMessages

      public void setMessages(List<String> messages)

    • raw

      public Transfer raw(Object raw)

    • getRaw

      @Nullable public Object getRaw()
      Raw response from the processor
      Returns:
      raw

    • setRaw

      public void setRaw(Object raw)

    • readyToSettleAt

      public Transfer readyToSettleAt(OffsetDateTime readyToSettleAt)

    • getReadyToSettleAt

      @Nullable public OffsetDateTime getReadyToSettleAt()
      Timestamp of when the `Transfer` is ready to be settled at.
      Returns:
      readyToSettleAt

    • setReadyToSettleAt

      public void setReadyToSettleAt(OffsetDateTime readyToSettleAt)

    • source

      public Transfer source(String source)

    • getSource

      @Nullable public String getSource()
      The ID of the resource.
      Returns:
      source

    • setSource

      public void setSource(String source)

    • state

      public Transfer state(Transfer.StateEnum state)

    • getState

      @Nullable public Transfer.StateEnum getState()
      The stauts of the `Transfer`.
      Returns:
      state

    • setState

      public void setState(Transfer.StateEnum state)

    • statementDescriptor

      public Transfer statementDescriptor(String statementDescriptor)

    • getStatementDescriptor

      @Nullable public String getStatementDescriptor()
      The description of the merchant that appears on the buyer's bank or card statement.
      Returns:
      statementDescriptor

    • setStatementDescriptor

      public void setStatementDescriptor(String statementDescriptor)

    • subtype

      public Transfer subtype(Transfer.SubtypeEnum subtype)

    • getSubtype

      @Nullable public Transfer.SubtypeEnum getSubtype()
      Additional information describing the `payment_type`.
      Returns:
      subtype

    • setSubtype

      public void setSubtype(Transfer.SubtypeEnum subtype)

    • traceId

      public Transfer traceId(String traceId)

    • getTraceId

      @Nullable public String getTraceId()
      Trace ID of the `Transfer`. The processor sends back the `trace_id` so you can track the `transfer` end-to-end.
      Returns:
      traceId

    • setTraceId

      public void setTraceId(String traceId)

    • externallyFunded

      public Transfer externallyFunded(String externallyFunded)

    • getExternallyFunded

      @Nullable public String getExternallyFunded()
      Details if the Transfer will be settled externally by card processors.
      Returns:
      externallyFunded

    • setExternallyFunded

      public void setExternallyFunded(String externallyFunded)

    • failureCode

      public Transfer failureCode(String failureCode)

    • getFailureCode

      @Nullable public String getFailureCode()
      When a transfer is declined. This is the code of the failure so the decline can be handled programmatically.
      Returns:
      failureCode

    • setFailureCode

      public void setFailureCode(String failureCode)

    • failureMessage

      public Transfer failureMessage(String failureMessage)

    • getFailureMessage

      @Nullable public String getFailureMessage()
      A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.
      Returns:
      failureMessage

    • setFailureMessage

      public void setFailureMessage(String failureMessage)

    • links

      public Transfer links(TransferLinks links)

    • getLinks

      @Nullable public TransferLinks getLinks()
      Get links
      Returns:
      links

    • setLinks

      public void setLinks(TransferLinks links)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonObject

      public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
      Validates the JSON Object and throws an exception if issues found
      Parameters:
      jsonObj - JSON Object
      Throws:
      IOException - if the JSON Object is invalid with respect to Transfer

    • fromJson

      public static Transfer fromJson(String jsonString) throws IOException
      Create an instance of Transfer given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of Transfer
      Throws:
      IOException - if the JSON string is invalid with respect to Transfer

    • toJson

      public String toJson()
      Convert an instance of Transfer to an JSON string
      Returns:
      JSON string