Package model

Class Transfer

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Transfer
extends Object

    • Constructor Detail

      • Transfer

        public Transfer()

    • Method Detail

      • getId

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

      • setId

        public void setId​(String id)

      • getCreatedAt

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

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getUpdatedAt

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

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getAdditionalBuyerCharges

        @Nullable
public AdditionalBuyerCharges getAdditionalBuyerCharges()
        Get additionalBuyerCharges
        Returns:
        additionalBuyerCharges

      • setAdditionalBuyerCharges

        public void setAdditionalBuyerCharges​(AdditionalBuyerCharges additionalBuyerCharges)

      • 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)

      • getApplication

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

      • setApplication

        public void setApplication​(String application)

      • getCardPresentDetails

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

      • setCardPresentDetails

        public void setCardPresentDetails​(CardPresentDetails cardPresentDetails)

      • getCurrency

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

      • setCurrency

        public void setCurrency​(Currency currency)

      • getDestination

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

      • setDestination

        public void setDestination​(String destination)

      • getDevice

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

      • setDevice

        public void setDevice​(String device)

      • 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)

      • getFailureCode

        @Nullable
public String getFailureCode()
        The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).
        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)

      • 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)

      • 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)

      • merchantIdentity

        public Transfer merchantIdentity​(String merchantIdentity)

      • getMerchantIdentity

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

      • setMerchantIdentity

        public void setMerchantIdentity​(String merchantIdentity)

      • addMessagesItem

        public Transfer addMessagesItem​(String messagesItem)

      • getMessages

        @Nullable
public List<String> getMessages()
        Message field that provides additional details. This field is typically **null**.
        Returns:
        messages

      • setMessages

        public void setMessages​(List<String> messages)

      • getRaw

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

      • setRaw

        public void setRaw​(Object raw)

      • getReadyToSettleAt

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

      • setReadyToSettleAt

        public void setReadyToSettleAt​(OffsetDateTime readyToSettleAt)

      • getSource

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

      • setSource

        public void setSource​(String source)

      • 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)

      • getTags

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

      • 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)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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