Package com.stripe.model

Class Topup

    • Constructor Detail

      • Topup

        public Topup()

    • Method Detail

      • getBalanceTransaction

        public java.lang.String getBalanceTransaction()
        Get ID of expandable balanceTransaction object.

      • setBalanceTransaction

        public void setBalanceTransaction​(java.lang.String id)

      • getBalanceTransactionObject

        public BalanceTransaction getBalanceTransactionObject()
        Get expanded balanceTransaction.

      • setBalanceTransactionObject

        public void setBalanceTransactionObject​(BalanceTransaction expandableObject)

      • create

        public static Topup create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                    throws StripeException
        Top up the balance of an account.
        Throws:
        StripeException

      • retrieve

        public static Topup retrieve​(java.lang.String topup)
                      throws StripeException
        Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
        Throws:
        StripeException

      • retrieve

        public static Topup retrieve​(java.lang.String topup,
                             RequestOptions options)
                      throws StripeException
        Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
        Throws:
        StripeException

      • retrieve

        public static Topup retrieve​(java.lang.String topup,
                             java.util.Map<java.lang.String,​java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
        Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
        Throws:
        StripeException

      • retrieve

        public static Topup retrieve​(java.lang.String topup,
                             TopupRetrieveParams params,
                             RequestOptions options)
                      throws StripeException
        Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
        Throws:
        StripeException

      • cancel

        public Topup cancel​(java.util.Map<java.lang.String,​java.lang.Object> params)
             throws StripeException
        Cancels a top-up. Only pending top-ups can be canceled.
        Throws:
        StripeException

      • getAmount

        public java.lang.Long getAmount()
        Amount transferred.

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getDescription

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

      • getExpectedAvailabilityDate

        public java.lang.Long getExpectedAvailabilityDate()
        Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.

      • getFailureCode

        public java.lang.String getFailureCode()
        Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

      • getFailureMessage

        public java.lang.String getFailureMessage()
        Message to user further explaining reason for top-up failure if available.

      • getLivemode

        public java.lang.Boolean getLivemode()
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to topup.

      • getSource

        public Source getSource()
        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.

        Related guides: Sources API and Sources & Customers.

      • getStatementDescriptor

        public java.lang.String getStatementDescriptor()
        Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.

      • getStatus

        public java.lang.String getStatus()
        The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

        One of canceled, failed, pending, reversed, or succeeded.

      • getTransferGroup

        public java.lang.String getTransferGroup()
        A string that identifies this top-up as part of a group.

      • setAmount

        public void setAmount​(java.lang.Long amount)
        Amount transferred.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setDescription

        public void setDescription​(java.lang.String description)
        An arbitrary string attached to the object. Often useful for displaying to users.

      • setExpectedAvailabilityDate

        public void setExpectedAvailabilityDate​(java.lang.Long expectedAvailabilityDate)
        Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.

      • setFailureCode

        public void setFailureCode​(java.lang.String failureCode)
        Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

      • setFailureMessage

        public void setFailureMessage​(java.lang.String failureMessage)
        Message to user further explaining reason for top-up failure if available.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setLivemode

        public void setLivemode​(java.lang.Boolean livemode)
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • setMetadata

        public void setMetadata​(java.util.Map<java.lang.String,​java.lang.String> metadata)
        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.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

        Equal to topup.

      • setSource

        public void setSource​(Source source)
        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.

        Related guides: Sources API and Sources & Customers.

      • setStatementDescriptor

        public void setStatementDescriptor​(java.lang.String statementDescriptor)
        Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.

      • setStatus

        public void setStatus​(java.lang.String status)
        The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

        One of canceled, failed, pending, reversed, or succeeded.

      • setTransferGroup

        public void setTransferGroup​(java.lang.String transferGroup)
        A string that identifies this top-up as part of a group.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.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.
        Specified by:
        getMetadata in interface MetadataStore<Topup>