Package com.stripe.model

Class Recipient

    • Constructor Detail

      • Recipient

        public Recipient()

    • Method Detail

      • getDefaultCard

        public java.lang.String getDefaultCard()
        Get ID of expandable defaultCard object.

      • setDefaultCard

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

      • getDefaultCardObject

        public Card getDefaultCardObject()
        Get expanded defaultCard.

      • setDefaultCardObject

        public void setDefaultCardObject​(Card expandableObject)

      • getMigratedTo

        public java.lang.String getMigratedTo()
        Get ID of expandable migratedTo object.

      • setMigratedTo

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

      • getMigratedToObject

        public Account getMigratedToObject()
        Get expanded migratedTo.

      • setMigratedToObject

        public void setMigratedToObject​(Account expandableObject)

      • getRolledBackFrom

        public java.lang.String getRolledBackFrom()
        Get ID of expandable rolledBackFrom object.

      • setRolledBackFrom

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

      • getRolledBackFromObject

        public Account getRolledBackFromObject()
        Get expanded rolledBackFrom.

      • setRolledBackFromObject

        public void setRolledBackFromObject​(Account expandableObject)

      • list

        public static RecipientCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params)
                                throws StripeException
        Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
        Throws:
        StripeException

      • list

        public static RecipientCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                       RequestOptions options)
                                throws StripeException
        Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
        Throws:
        StripeException

      • create

        public static Recipient create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                        throws StripeException
        Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.
        Throws:
        StripeException

      • create

        public static Recipient create​(java.util.Map<java.lang.String,​java.lang.Object> params,
                               RequestOptions options)
                        throws StripeException
        Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.
        Throws:
        StripeException

      • retrieve

        public static Recipient retrieve​(java.lang.String id)
                          throws StripeException
        Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
        Throws:
        StripeException

      • retrieve

        public static Recipient retrieve​(java.lang.String id,
                                 RequestOptions options)
                          throws StripeException
        Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
        Throws:
        StripeException

      • retrieve

        public static Recipient retrieve​(java.lang.String id,
                                 java.util.Map<java.lang.String,​java.lang.Object> params,
                                 RequestOptions options)
                          throws StripeException
        Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
        Throws:
        StripeException

      • update

        public Recipient update​(java.util.Map<java.lang.String,​java.lang.Object> params)
                 throws StripeException
        Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

        Specified by:
        update in interface MetadataStore<Recipient>
        Throws:
        StripeException

      • update

        public Recipient update​(java.util.Map<java.lang.String,​java.lang.Object> params,
                        RequestOptions options)
                 throws StripeException
        Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

        Specified by:
        update in interface MetadataStore<Recipient>
        Throws:
        StripeException

      • update

        public Recipient update​(RecipientUpdateParams params)
                 throws StripeException
        Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

        Throws:
        StripeException

      • update

        public Recipient update​(RecipientUpdateParams params,
                        RequestOptions options)
                 throws StripeException
        Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

        If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

        Throws:
        StripeException

      • delete

        public Recipient delete​(java.util.Map<java.lang.String,​java.lang.Object> params)
                 throws StripeException
        Permanently deletes a recipient. It cannot be undone.
        Throws:
        StripeException

      • getActiveAccount

        public BankAccount getActiveAccount()
        Hash describing the current account on the recipient, if there is one.

      • getCreated

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

      • getDeleted

        public java.lang.Boolean getDeleted()
        Always true for a deleted object.

      • getDescription

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

      • getEmail

        public java.lang.String getEmail()

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

      • getName

        public java.lang.String getName()
        Full, legal name of the recipient.

      • getObject

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

        Equal to recipient.

      • getType

        public java.lang.String getType()
        Type of the recipient, one of individual or corporation.

      • getVerified

        public java.lang.Boolean getVerified()
        Whether the recipient has been verified. This field is non-standard, and maybe removed in the future

      • setActiveAccount

        public void setActiveAccount​(BankAccount activeAccount)
        Hash describing the current account on the recipient, if there is one.

      • setCreated

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

      • setDeleted

        public void setDeleted​(java.lang.Boolean deleted)
        Always true for a deleted object.

      • setDescription

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

      • setEmail

        public void setEmail​(java.lang.String email)

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

      • setName

        public void setName​(java.lang.String name)
        Full, legal name of the recipient.

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

      • setType

        public void setType​(java.lang.String type)
        Type of the recipient, one of individual or corporation.

      • setVerified

        public void setVerified​(java.lang.Boolean verified)
        Whether the recipient has been verified. This field is non-standard, and maybe removed in the future

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