Class UltimatePartyIdentification


  • public class UltimatePartyIdentification
    extends Object
    UltimatePartyIdentification
    • Constructor Detail

      • UltimatePartyIdentification

        public UltimatePartyIdentification()
    • Method Detail

      • address

        public UltimatePartyIdentification address​(Address address)
        address
        Parameters:
        address -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getAddress

        public Address getAddress()
        address
        Returns:
        address
      • setAddress

        public void setAddress​(Address address)
        address
        Parameters:
        address -
      • dateOfBirth

        public UltimatePartyIdentification dateOfBirth​(LocalDate dateOfBirth)
        The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Allowed only when `type` is **individual**.
        Parameters:
        dateOfBirth -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getDateOfBirth

        public LocalDate getDateOfBirth()
        The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Allowed only when `type` is **individual**.
        Returns:
        dateOfBirth
      • setDateOfBirth

        public void setDateOfBirth​(LocalDate dateOfBirth)
        The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Allowed only when `type` is **individual**.
        Parameters:
        dateOfBirth -
      • firstName

        public UltimatePartyIdentification firstName​(String firstName)
        The first name of the individual. Supported characters: [a-z] [A-Z] - . / — and space. This parameter is: - Allowed only when `type` is **individual**. - Required when `category` is **card**.
        Parameters:
        firstName -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getFirstName

        public String getFirstName()
        The first name of the individual. Supported characters: [a-z] [A-Z] - . / — and space. This parameter is: - Allowed only when `type` is **individual**. - Required when `category` is **card**.
        Returns:
        firstName
      • setFirstName

        public void setFirstName​(String firstName)
        The first name of the individual. Supported characters: [a-z] [A-Z] - . / — and space. This parameter is: - Allowed only when `type` is **individual**. - Required when `category` is **card**.
        Parameters:
        firstName -
      • fullName

        public UltimatePartyIdentification fullName​(String fullName)
        The full name of the entity that owns the bank account or card. Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space. Required when `category` is **bank**.
        Parameters:
        fullName -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getFullName

        public String getFullName()
        The full name of the entity that owns the bank account or card. Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space. Required when `category` is **bank**.
        Returns:
        fullName
      • setFullName

        public void setFullName​(String fullName)
        The full name of the entity that owns the bank account or card. Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space. Required when `category` is **bank**.
        Parameters:
        fullName -
      • lastName

        public UltimatePartyIdentification lastName​(String lastName)
        The last name of the individual. Supported characters: [a-z] [A-Z] - . / — and space. This parameter is: - Allowed only when `type` is **individual**. - Required when `category` is **card**.
        Parameters:
        lastName -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getLastName

        public String getLastName()
        The last name of the individual. Supported characters: [a-z] [A-Z] - . / — and space. This parameter is: - Allowed only when `type` is **individual**. - Required when `category` is **card**.
        Returns:
        lastName
      • setLastName

        public void setLastName​(String lastName)
        The last name of the individual. Supported characters: [a-z] [A-Z] - . / — and space. This parameter is: - Allowed only when `type` is **individual**. - Required when `category` is **card**.
        Parameters:
        lastName -
      • reference

        public UltimatePartyIdentification reference​(String reference)
        A unique reference to identify the party or counterparty involved in the transfer. For example, your client's unique wallet or payee ID. Required when you include `cardIdentification.storedPaymentMethodId`.
        Parameters:
        reference -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getReference

        public String getReference()
        A unique reference to identify the party or counterparty involved in the transfer. For example, your client's unique wallet or payee ID. Required when you include `cardIdentification.storedPaymentMethodId`.
        Returns:
        reference
      • setReference

        public void setReference​(String reference)
        A unique reference to identify the party or counterparty involved in the transfer. For example, your client's unique wallet or payee ID. Required when you include `cardIdentification.storedPaymentMethodId`.
        Parameters:
        reference -
      • type

        public UltimatePartyIdentification type​(UltimatePartyIdentification.TypeEnum type)
        The type of entity that owns the bank account or card. Possible values: **individual**, **organization**, or **unknown**. Required when `category` is **card**. In this case, the value must be **individual**.
        Parameters:
        type -
        Returns:
        the current UltimatePartyIdentification instance, allowing for method chaining
      • getType

        public UltimatePartyIdentification.TypeEnum getType()
        The type of entity that owns the bank account or card. Possible values: **individual**, **organization**, or **unknown**. Required when `category` is **card**. In this case, the value must be **individual**.
        Returns:
        type
      • setType

        public void setType​(UltimatePartyIdentification.TypeEnum type)
        The type of entity that owns the bank account or card. Possible values: **individual**, **organization**, or **unknown**. Required when `category` is **card**. In this case, the value must be **individual**.
        Parameters:
        type -
      • equals

        public boolean equals​(Object o)
        Return true if this UltimatePartyIdentification object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

        public static UltimatePartyIdentification fromJson​(String jsonString)
                                                    throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of UltimatePartyIdentification given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of UltimatePartyIdentification
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to UltimatePartyIdentification
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of UltimatePartyIdentification to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException