Package com.stripe.model

Class Payout

    • Constructor Detail

      • Payout

        public Payout()

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

      • getDestination

        public java.lang.String getDestination()
        Get ID of expandable destination object.

      • setDestination

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

      • getDestinationObject

        public ExternalAccount getDestinationObject()
        Get expanded destination.

      • setDestinationObject

        public void setDestinationObject​(ExternalAccount expandableObject)

      • getFailureBalanceTransaction

        public java.lang.String getFailureBalanceTransaction()
        Get ID of expandable failureBalanceTransaction object.

      • setFailureBalanceTransaction

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

      • getFailureBalanceTransactionObject

        public BalanceTransaction getFailureBalanceTransactionObject()
        Get expanded failureBalanceTransaction.

      • setFailureBalanceTransactionObject

        public void setFailureBalanceTransactionObject​(BalanceTransaction expandableObject)

      • getOriginalPayout

        public java.lang.String getOriginalPayout()
        Get ID of expandable originalPayout object.

      • setOriginalPayout

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

      • getOriginalPayoutObject

        public Payout getOriginalPayoutObject()
        Get expanded originalPayout.

      • setOriginalPayoutObject

        public void setOriginalPayoutObject​(Payout expandableObject)

      • getReversedBy

        public java.lang.String getReversedBy()
        Get ID of expandable reversedBy object.

      • setReversedBy

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

      • getReversedByObject

        public Payout getReversedByObject()
        Get expanded reversedBy.

      • setReversedByObject

        public void setReversedByObject​(Payout expandableObject)

      • retrieve

        public static Payout retrieve​(java.lang.String payout)
                       throws StripeException
        Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
        Throws:
        StripeException

      • retrieve

        public static Payout retrieve​(java.lang.String payout,
                              RequestOptions options)
                       throws StripeException
        Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
        Throws:
        StripeException

      • retrieve

        public static Payout retrieve​(java.lang.String payout,
                              java.util.Map<java.lang.String,​java.lang.Object> params,
                              RequestOptions options)
                       throws StripeException
        Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
        Throws:
        StripeException

      • retrieve

        public static Payout retrieve​(java.lang.String payout,
                              PayoutRetrieveParams params,
                              RequestOptions options)
                       throws StripeException
        Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
        Throws:
        StripeException

      • list

        public static PayoutCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params)
                             throws StripeException
        Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
        Throws:
        StripeException

      • list

        public static PayoutCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                    RequestOptions options)
                             throws StripeException
        Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
        Throws:
        StripeException

      • list

        public static PayoutCollection list​(PayoutListParams params)
                             throws StripeException
        Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
        Throws:
        StripeException

      • create

        public static Payout create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                     throws StripeException
        To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

        If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

        If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

        Throws:
        StripeException

      • create

        public static Payout create​(java.util.Map<java.lang.String,​java.lang.Object> params,
                            RequestOptions options)
                     throws StripeException
        To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

        If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

        If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

        Throws:
        StripeException

      • create

        public static Payout create​(PayoutCreateParams params)
                     throws StripeException
        To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

        If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

        If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

        Throws:
        StripeException

      • create

        public static Payout create​(PayoutCreateParams params,
                            RequestOptions options)
                     throws StripeException
        To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

        If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

        If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

        Throws:
        StripeException

      • update

        public Payout update​(java.util.Map<java.lang.String,​java.lang.Object> params)
              throws StripeException
        Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
        Specified by:
        update in interface MetadataStore<Payout>
        Throws:
        StripeException

      • update

        public Payout update​(java.util.Map<java.lang.String,​java.lang.Object> params,
                     RequestOptions options)
              throws StripeException
        Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
        Specified by:
        update in interface MetadataStore<Payout>
        Throws:
        StripeException

      • update

        public Payout update​(PayoutUpdateParams params)
              throws StripeException
        Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
        Throws:
        StripeException

      • cancel

        public Payout cancel()
              throws StripeException
        A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
        Throws:
        StripeException

      • cancel

        public Payout cancel​(RequestOptions options)
              throws StripeException
        A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
        Throws:
        StripeException

      • cancel

        public Payout cancel​(java.util.Map<java.lang.String,​java.lang.Object> params)
              throws StripeException
        A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
        Throws:
        StripeException

      • cancel

        public Payout cancel​(java.util.Map<java.lang.String,​java.lang.Object> params,
                     RequestOptions options)
              throws StripeException
        A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
        Throws:
        StripeException

      • cancel

        public Payout cancel​(PayoutCancelParams params)
              throws StripeException
        A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
        Throws:
        StripeException

      • reverse

        public Payout reverse()
               throws StripeException
        Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

        By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

        Throws:
        StripeException

      • reverse

        public Payout reverse​(RequestOptions options)
               throws StripeException
        Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

        By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

        Throws:
        StripeException

      • reverse

        public Payout reverse​(java.util.Map<java.lang.String,​java.lang.Object> params)
               throws StripeException
        Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

        By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

        Throws:
        StripeException

      • reverse

        public Payout reverse​(java.util.Map<java.lang.String,​java.lang.Object> params,
                      RequestOptions options)
               throws StripeException
        Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

        By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

        Throws:
        StripeException

      • reverse

        public Payout reverse​(PayoutReverseParams params)
               throws StripeException
        Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

        By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

        Throws:
        StripeException

      • reverse

        public Payout reverse​(PayoutReverseParams params,
                      RequestOptions options)
               throws StripeException
        Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

        By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

        Throws:
        StripeException

      • getAmount

        public java.lang.Long getAmount()
        Amount (in %s) to be transferred to your bank account or debit card.

      • getArrivalDate

        public java.lang.Long getArrivalDate()
        Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.

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

      • getFailureCode

        public java.lang.String getFailureCode()
        Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.

      • getFailureMessage

        public java.lang.String getFailureMessage()
        Message to user further explaining reason for payout 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.

      • getMethod

        public java.lang.String getMethod()
        The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

      • getObject

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

        Equal to payout.

      • getSourceType

        public java.lang.String getSourceType()
        The source balance this payout came from. One of card, fpx, or bank_account.

      • getStatementDescriptor

        public java.lang.String getStatementDescriptor()
        Extra information about a payout to be displayed on the user's bank statement.

      • getStatus

        public java.lang.String getStatus()
        Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.

      • getType

        public java.lang.String getType()
        Can be bank_account or card.

      • setAmount

        public void setAmount​(java.lang.Long amount)
        Amount (in %s) to be transferred to your bank account or debit card.

      • setArrivalDate

        public void setArrivalDate​(java.lang.Long arrivalDate)
        Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.

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

      • setFailureCode

        public void setFailureCode​(java.lang.String failureCode)
        Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.

      • setFailureMessage

        public void setFailureMessage​(java.lang.String failureMessage)
        Message to user further explaining reason for payout 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.

      • setMethod

        public void setMethod​(java.lang.String method)
        The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

      • 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 payout.

      • setSourceType

        public void setSourceType​(java.lang.String sourceType)
        The source balance this payout came from. One of card, fpx, or bank_account.

      • setStatementDescriptor

        public void setStatementDescriptor​(java.lang.String statementDescriptor)
        Extra information about a payout to be displayed on the user's bank statement.

      • setStatus

        public void setStatus​(java.lang.String status)
        Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.

      • setType

        public void setType​(java.lang.String type)
        Can be bank_account or card.

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