Class PartyIdentification


  • public class PartyIdentification
    extends Object
    PartyIdentification
    • Constructor Detail

      • PartyIdentification

        public PartyIdentification()
    • Method Detail

      • address

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

        public Address getAddress()
        Get address
        Returns:
        address
      • setAddress

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

        public PartyIdentification 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 - 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:
        the current PartyIdentification 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 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**.
      • 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 - 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**.
      • email

        public PartyIdentification email​(String email)
        The email address of the organization or individual. Maximum length: 254 characters.
        Parameters:
        email - The email address of the organization or individual. Maximum length: 254 characters.
        Returns:
        the current PartyIdentification instance, allowing for method chaining
      • getEmail

        public String getEmail()
        The email address of the organization or individual. Maximum length: 254 characters.
        Returns:
        email The email address of the organization or individual. Maximum length: 254 characters.
      • setEmail

        public void setEmail​(String email)
        The email address of the organization or individual. Maximum length: 254 characters.
        Parameters:
        email - The email address of the organization or individual. Maximum length: 254 characters.
      • firstName

        public PartyIdentification 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 - 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:
        the current PartyIdentification 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 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**.
      • 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 - 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**.
      • fullName

        public PartyIdentification 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 - 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:
        the current PartyIdentification 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 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**.
      • 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 - 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**.
      • lastName

        public PartyIdentification 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 - 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:
        the current PartyIdentification 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 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**.
      • 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 - 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**.
      • reference

        public PartyIdentification 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 - 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:
        the current PartyIdentification 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 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`.
      • 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 - 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`.
      • type

        public PartyIdentification type​(PartyIdentification.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 - 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:
        the current PartyIdentification instance, allowing for method chaining
      • getType

        public PartyIdentification.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 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**.
      • setType

        public void setType​(PartyIdentification.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 - 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**.
      • url

        public PartyIdentification url​(String url)
        The URL of the organization or individual. Maximum length: 255 characters.
        Parameters:
        url - The URL of the organization or individual. Maximum length: 255 characters.
        Returns:
        the current PartyIdentification instance, allowing for method chaining
      • getUrl

        public String getUrl()
        The URL of the organization or individual. Maximum length: 255 characters.
        Returns:
        url The URL of the organization or individual. Maximum length: 255 characters.
      • setUrl

        public void setUrl​(String url)
        The URL of the organization or individual. Maximum length: 255 characters.
        Parameters:
        url - The URL of the organization or individual. Maximum length: 255 characters.
      • equals

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

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

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

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