com.simplify.payments.domain

Class Customer

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.Customer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class Customer
extends PaymentsObject

A Customer object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Customer()
protected	Customer(java.util.Map m)
protected	Customer(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static Customer	create(Authentication auth, java.util.Map map) Creates an Customer object
static Customer	create(java.util.Map map) Creates an Customer object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Customer	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
Customer	delete() Deletes an Customer object.
static Customer	find(Authentication auth, java.lang.String id) Retrieve a Customer object.
static Customer	find(java.lang.String id) Retrieve a Customer object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Customer	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
static ResourceList<Customer>	list() Retrieve Customer objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Customer>	list(Authentication auth) Retrieve Customer objects using the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Customer>	list(Authentication auth, java.util.Map criteria) Retrieve Customer objects using the specified criteria.
static ResourceList<Customer>	list(java.util.Map criteria) Retrieve Customer objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static ResourceList<Customer>	list(java.lang.String publicKey, java.lang.String privateKey) Deprecated. As of release 1.1, replaced by list(Authentication)
static ResourceList<Customer>	list(java.lang.String publicKey, java.lang.String privateKey, java.util.Map criteria) Deprecated. As of release 1.1, replaced by list(Authentication, Map)
Customer	update() Updates an Customer object.

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

Customer

protected Customer()

Customer

protected Customer(PaymentsObject o)

Customer

protected Customer(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static Customer create(java.util.Map map)
                       throws ApiCommunicationException,
                              AuthenticationException,
                              InvalidRequestException,
                              NotAllowedException,
                              SystemException

Creates an Customer object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

payments.command.api.APICustomerCardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. required

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. required

java.lang.String card.addressLine1

Address of the cardholder required

java.lang.String card.addressLine2

Address of the cardholder if needed. required

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. required

java.lang.String card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. required

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123 required

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 required

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 required

java.lang.String card.id

ID of card. Unused during customer create.

java.lang.String card.name

Name as appears on the card. required

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String email

Email address of the customer required

java.lang.String name

Customer name [max length: 50, min length: 2] required

java.lang.String reference

Reference field for external applications use.

payments.command.api.APISubscriptionCreateCommand subscriptions

Subscriptions for the customer

java.lang.Long subscriptions.amount

Amount of payment in the smallest unit of your currency. Example: 100 = $1.00

java.lang.String subscriptions.billingCycle

How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]

java.lang.Integer subscriptions.billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

java.lang.String subscriptions.coupon

Coupon associated with the subscription for the customer.

java.lang.String subscriptions.currency

Currency code (ISO-4217). Must match the currency associated with your account.

java.lang.Long subscriptions.currentPeriodEnd

End date of subscription's current period

java.lang.Long subscriptions.currentPeriodStart

Start date of subscription's current period

java.lang.String subscriptions.customer

The customer ID to create the subscription for. Do not supply this when creating a customer.

java.lang.String subscriptions.frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".

java.lang.Integer subscriptions.frequencyPeriod

Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.

java.lang.String subscriptions.name

Name describing subscription [max length: 50]

java.lang.String subscriptions.plan

The plan ID that the subscription should be created from.

java.lang.Integer subscriptions.quantity

Quantity of the plan for the subscription. [min value: 1]

java.lang.Integer subscriptions.renewalReminderLeadDays

If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.

java.lang.String subscriptions.source

Source of where subscription was created

java.lang.String token

If specified, card associated with card token will be used

Returns:

a Customer object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Customer create(java.lang.String publicKey,
                                          java.lang.String privateKey,
                                          java.util.Map map)
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          NotAllowedException,
                                          SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an Customer object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

payments.command.api.APICustomerCardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. required

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. required

java.lang.String card.addressLine1

Address of the cardholder required

java.lang.String card.addressLine2

Address of the cardholder if needed. required

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. required

java.lang.String card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. required

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123 required

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 required

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 required

java.lang.String card.id

ID of card. Unused during customer create.

java.lang.String card.name

Name as appears on the card. required

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String email

Email address of the customer required

java.lang.String name

Customer name [max length: 50, min length: 2] required

java.lang.String reference

Reference field for external applications use.

payments.command.api.APISubscriptionCreateCommand subscriptions

Subscriptions for the customer

java.lang.Long subscriptions.amount

Amount of payment in the smallest unit of your currency. Example: 100 = $1.00

java.lang.String subscriptions.billingCycle

How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]

java.lang.Integer subscriptions.billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

java.lang.String subscriptions.coupon

Coupon associated with the subscription for the customer.

java.lang.String subscriptions.currency

Currency code (ISO-4217). Must match the currency associated with your account.

java.lang.Long subscriptions.currentPeriodEnd

End date of subscription's current period

java.lang.Long subscriptions.currentPeriodStart

Start date of subscription's current period

java.lang.String subscriptions.customer

The customer ID to create the subscription for. Do not supply this when creating a customer.

java.lang.String subscriptions.frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".

java.lang.Integer subscriptions.frequencyPeriod

Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.

java.lang.String subscriptions.name

Name describing subscription [max length: 50]

java.lang.String subscriptions.plan

The plan ID that the subscription should be created from.

java.lang.Integer subscriptions.quantity

Quantity of the plan for the subscription. [min value: 1]

java.lang.Integer subscriptions.renewalReminderLeadDays

If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.

java.lang.String subscriptions.source

Source of where subscription was created

java.lang.String token

If specified, card associated with card token will be used

Returns:

a Customer object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static Customer create(Authentication auth,
                              java.util.Map map)
                       throws ApiCommunicationException,
                              AuthenticationException,
                              InvalidRequestException,
                              NotAllowedException,
                              SystemException

Creates an Customer object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

payments.command.api.APICustomerCardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. required

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. required

java.lang.String card.addressLine1

Address of the cardholder required

java.lang.String card.addressLine2

Address of the cardholder if needed. required

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. required

java.lang.String card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. required

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123 required

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 required

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 required

java.lang.String card.id

ID of card. Unused during customer create.

java.lang.String card.name

Name as appears on the card. required

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String email

Email address of the customer required

java.lang.String name

Customer name [max length: 50, min length: 2] required

java.lang.String reference

Reference field for external applications use.

payments.command.api.APISubscriptionCreateCommand subscriptions

Subscriptions for the customer

java.lang.Long subscriptions.amount

Amount of payment in the smallest unit of your currency. Example: 100 = $1.00

java.lang.String subscriptions.billingCycle

How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]

java.lang.Integer subscriptions.billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

java.lang.String subscriptions.coupon

Coupon associated with the subscription for the customer.

java.lang.String subscriptions.currency

Currency code (ISO-4217). Must match the currency associated with your account.

java.lang.Long subscriptions.currentPeriodEnd

End date of subscription's current period

java.lang.Long subscriptions.currentPeriodStart

Start date of subscription's current period

java.lang.String subscriptions.customer

The customer ID to create the subscription for. Do not supply this when creating a customer.

java.lang.String subscriptions.frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".

java.lang.Integer subscriptions.frequencyPeriod

Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.

java.lang.String subscriptions.name

Name describing subscription [max length: 50]

java.lang.String subscriptions.plan

The plan ID that the subscription should be created from.

java.lang.Integer subscriptions.quantity

Quantity of the plan for the subscription. [min value: 1]

java.lang.Integer subscriptions.renewalReminderLeadDays

If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.

java.lang.String subscriptions.source

Source of where subscription was created

java.lang.String token

If specified, card associated with card token will be used

Returns:

a Customer object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

public Customer delete()
                throws ApiCommunicationException,
                       AuthenticationException,
                       InvalidRequestException,
                       ObjectNotFoundException,
                       NotAllowedException,
                       SystemException

Deletes an Customer object.

Returns:

a Customer object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

list

public static ResourceList<Customer> list()
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          NotAllowedException,
                                          SystemException

Retrieve Customer objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).

Returns:

a ResourceList object which holds the list of Customer objects and the total number of Customer objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Customer> list(java.lang.String publicKey,
                                                      java.lang.String privateKey)
                                               throws ApiCommunicationException,
                                                      AuthenticationException,
                                                      InvalidRequestException,
                                                      NotAllowedException,
                                                      SystemException

Deprecated. As of release 1.1, replaced by list(Authentication)

Retrieve Customer objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Customer objects and the total number of Customer objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Customer> list(Authentication auth)
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          NotAllowedException,
                                          SystemException

Retrieve Customer objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

Returns:

a ResourceList object which holds the list of Customer objects and the total number of Customer objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Customer> list(java.util.Map criteria)
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          NotAllowedException,
                                          SystemException

Retrieve Customer objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the customer Id
filter.text	Can use this to filter by the name, email or reference for the customer
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated id name email reference .

Returns:

a ResourceList object which holds the list of Customer objects and the total number of Customer objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Customer> list(java.lang.String publicKey,
                                          java.lang.String privateKey,
                                          java.util.Map criteria)
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          NotAllowedException,
                                          SystemException

Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Retrieve Customer objects using the specified criteria.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the customer Id
filter.text	Can use this to filter by the name, email or reference for the customer
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated id name email reference .

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Customer objects and the total number of Customer objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Customer> list(Authentication auth,
                                          java.util.Map criteria)
                                   throws ApiCommunicationException,
                                          AuthenticationException,
                                          InvalidRequestException,
                                          NotAllowedException,
                                          SystemException

Retrieve Customer objects using the specified criteria.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the customer Id
filter.text	Can use this to filter by the name, email or reference for the customer
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated id name email reference .

Returns:

a ResourceList object which holds the list of Customer objects and the total number of Customer objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

public static Customer find(java.lang.String id)
                     throws ApiCommunicationException,
                            AuthenticationException,
                            InvalidRequestException,
                            ObjectNotFoundException,
                            NotAllowedException,
                            SystemException

Retrieve a Customer object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the Customer object to retrieve

Returns:

a Customer object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static Customer find(java.lang.String publicKey,
                                        java.lang.String privateKey,
                                        java.lang.String id)
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        ObjectNotFoundException,
                                        NotAllowedException,
                                        SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a Customer object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the Customer object to retrieve

Returns:

a Customer object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static Customer find(Authentication auth,
                            java.lang.String id)
                     throws ApiCommunicationException,
                            AuthenticationException,
                            InvalidRequestException,
                            ObjectNotFoundException,
                            NotAllowedException,
                            SystemException

Retrieve a Customer object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the Customer object to retrieve

Returns:

a Customer object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public Customer update()
                throws ApiCommunicationException,
                       AuthenticationException,
                       InvalidRequestException,
                       ObjectNotFoundException,
                       NotAllowedException,
                       SystemException

Updates an Customer object. The properties that can be updated:

• card
• addressCity (required)
• addressCountry (required)
• addressLine1 (required)
• addressLine2 (required)
• addressState (required)
• addressZip (required)
• cvc (required)
• expMonth (required)
• expYear (required)
• id
• name (required)
• number
• email (required)
• name (required)
• reference
• token

Returns:

a Customer object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException