RecurringCustomer (java-sdk 3.37.3 API)

java.lang.Object
- com.cardpay.sdk.model.RecurringCustomer

public class RecurringCustomer
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RecurringCustomer.LocaleEnum` Preferred locale for the payment page ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code).

Constructor Summary

Constructors
Constructor and Description

RecurringCustomer()

Constructors
Constructor and Description
`RecurringCustomer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecurringCustomer`	`contractNumber(String contractNumber)`
`RecurringCustomer`	`email(String email)`
`RecurringCustomer`	`homePhone(String homePhone)`
`RecurringCustomer`	`id(String id)`
`RecurringCustomer`	`identity(String identity)`
`RecurringCustomer`	`ip(String ip)`
`RecurringCustomer`	`ipCountry(String ipCountry)`
`RecurringCustomer`	`locale(RecurringCustomer.LocaleEnum locale)`
`RecurringCustomer`	`phone(String phone)`
`void`	`setContractNumber(String contractNumber)`
`void`	`setEmail(String email)`
`void`	`setHomePhone(String homePhone)`
`void`	`setId(String id)`
`void`	`setIdentity(String identity)`
`void`	`setIp(String ip)`
`void`	`setIpCountry(String ipCountry)`
`void`	`setLocale(RecurringCustomer.LocaleEnum locale)`
`void`	`setPhone(String phone)`
`void`	`setUserAgent(String userAgent)`
`void`	`setWorkPhone(String workPhone)`
`String`	`toString()`
`RecurringCustomer`	`userAgent(String userAgent)`
`RecurringCustomer`	`workPhone(String workPhone)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecurringCustomer
```
public RecurringCustomer()
```
- Method Detail
  - setContractNumber
```
public void setContractNumber(String contractNumber)
```
  - contractNumber
```
public RecurringCustomer contractNumber(String contractNumber)
```
    Parameters:
    
    contractNumber - Contract number between customer and merchant. Required for Mexican merchants for scheduled payments.
    
    Returns:
    
    bean instance
  - setEmail
```
public void setEmail(String email)
```
  - email
```
public RecurringCustomer email(String email)
```
    Parameters:
    
    email - Customer's e-mail address. Mandatory by default, can be defined as optional by CardPay manager.
    
    Returns:
    
    bean instance
  - setHomePhone
```
public void setHomePhone(String homePhone)
```
  - homePhone
```
public RecurringCustomer homePhone(String homePhone)
```
    Parameters:
    
    homePhone - The work phone number provided by the Cardholder. Required (if available), unless market or regional mandate restricts sending this information. Characters Format: string (10-18 symbols) country code + Subscriber number. Refer to ITU-E.164 for additional information on format and length.
    
    Returns:
    
    bean instance
  - setId
```
public void setId(String id)
```
  - id
```
public RecurringCustomer id(String id)
```
    Parameters:
    
    id - Customer's ID in Merchant's system
    
    Returns:
    
    bean instance
  - setIdentity
```
public void setIdentity(String identity)
```
  - identity
```
public RecurringCustomer identity(String identity)
```
    Parameters:
    
    identity - Customer's identity in Merchant's system required for Brazil Installments
    
    Returns:
    
    bean instance
  - setIp
```
public void setIp(String ip)
```
  - ip
```
public RecurringCustomer ip(String ip)
```
    Parameters:
    
    ip - Customer IPv4
    
    Returns:
    
    bean instance
  - setIpCountry
```
public void setIpCountry(String ipCountry)
```
  - ipCountry
```
public RecurringCustomer ipCountry(String ipCountry)
```
    Parameters:
    
    ipCountry - Customer country by IP
    
    Returns:
    
    bean instance
  - setLocale
```
public void setLocale(RecurringCustomer.LocaleEnum locale)
```
  - locale
```
public RecurringCustomer locale(RecurringCustomer.LocaleEnum locale)
```
    Parameters:
    
    locale - Preferred locale for the payment page ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code). The default locale will be applied if the selected locale is not supported. Supported locales are: `ru`, `en`, `zh`, `ja`
    
    Returns:
    
    bean instance
  - setPhone
```
public void setPhone(String phone)
```
  - phone
```
public RecurringCustomer phone(String phone)
```
    Parameters:
    
    phone - Customer phone number. Optional by default, can be defined as mandatory by CardPay manager.
    
    Returns:
    
    bean instance
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
  - userAgent
```
public RecurringCustomer userAgent(String userAgent)
```
    Parameters:
    
    userAgent - User agent
    
    Returns:
    
    bean instance
  - setWorkPhone
```
public void setWorkPhone(String workPhone)
```
  - workPhone
```
public RecurringCustomer workPhone(String workPhone)
```
    Parameters:
    
    workPhone - The home phone number provided by the Cardholder. Required (if available) unless market or regional mandate restricts sending this information. Characters Format: string (10-18 symbols) country code + Subscriber number. Refer to ITU-E.164 for additional information on format and length.
    
    Returns:
    
    bean instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RecurringCustomer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecurringCustomer

Method Detail

setContractNumber

contractNumber

setEmail

email

setHomePhone

homePhone

setId

id

setIdentity

identity

setIp

ip

setIpCountry

ipCountry

setLocale

locale

setPhone

phone

setUserAgent

userAgent

setWorkPhone

workPhone

toString