org.wisepersist.pinpayments.api.impl

Class CustomersApiImpl

java.lang.Object

org.wisepersist.pinpayments.api.impl.AbstractBaseApi

org.wisepersist.pinpayments.api.impl.CustomersApiImpl

All Implemented Interfaces:

CustomersApi

public class CustomersApiImpl
extends AbstractBaseApi
implements CustomersApi

Implementation of CustomersApi interface.

Constructor Summary

Constructors

Constructor and Description
CustomersApiImpl()

Method Summary

Modifier and Type	Method and Description
CustomerResponse	create(Customer customer) Creates a new customer and returns its details.
CardResponse	createCard(java.lang.String customerToken, Card card) Creates an additional card for the specified customer and returns its details.
DeletionResult	delete(java.lang.String customerToken) Deletes a customer and all of its cards.
DeletionResult	deleteCard(java.lang.String customerToken, java.lang.String cardToken) Deletes a customer’s non-primary card.
CustomerResponse	fetch(java.lang.String customerToken) Returns the details of a customer.
protected java.lang.String	getApiName()
CustomerListResponse	list(int page) Returns a paginated list of all customers.
CardListResponse	listCards(java.lang.String customerToken, int page) Returns a paginated list of a customer’s cards.
ChargeListResponse	listCharges(java.lang.String customerToken, int page) Returns a paginated list of a customer’s charges.
CustomerResponse	update(java.lang.String customerToken, Customer customer) Updates the given details of a customer and returns its details.

Methods inherited from class org.wisepersist.pinpayments.api.impl.AbstractBaseApi

executeList, executeSearch, getApiBase, getApiUrl, getDeletionResult, httpTransportForDelete, httpTransportForGet, httpTransportForPost, httpTransportForPut

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomersApiImpl

public CustomersApiImpl()

Method Detail

create

public final CustomerResponse create(Customer customer)
                              throws java.io.IOException

Description copied from interface: CustomersApi

Creates a new customer and returns its details.

Specified by:

create in interface CustomersApi

Parameters:

customer - The new customer specified.

Returns:

The details of the new customer specified.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

list

public final CustomerListResponse list(int page)
                                throws java.io.IOException

Description copied from interface: CustomersApi

Returns a paginated list of all customers.

Specified by:

list in interface CustomersApi

Parameters:

page - The page number specified.

Returns:

A paginated list of all customers.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

fetch

public final CustomerResponse fetch(java.lang.String customerToken)
                             throws java.io.IOException

Description copied from interface: CustomersApi

Returns the details of a customer.

Specified by:

fetch in interface CustomersApi

Parameters:

customerToken - The customer token specified.

Returns:

The details of the customer fetched.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

update

public final CustomerResponse update(java.lang.String customerToken,
                                     Customer customer)
                              throws java.io.IOException

Description copied from interface: CustomersApi

Updates the given details of a customer and returns its details. You can update the customer’s cards in one of four ways:

• You can use the card[...] parameters to create a new card that will replace the customer’s primary card. The customer’s current primary card will be deleted; you will not be able to recover it.
• You can use the card_token parameter to replace the customer’s primary card with a card already belonging to the customer or an already-existing unused card (such as one created through the card tokens API). The customer’s current primary card will be deleted; you will not be able to recover it.
• You can use the primary_card_token parameter to switch the customer’s primary card to a card already belonging to the customer or to an existing unused card (such as one created through the card tokens API). The current primary card will become a non-primary card of the customer.
• You can use none of the above parameters. The customer’s cards will not change.

In addition, you can update the customer’s email address.

Specified by:

update in interface CustomersApi

Parameters:

customerToken - The customer token specified.

customer - The new customer specified.

Returns:

The details of the customer updated.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

delete

public final DeletionResult delete(java.lang.String customerToken)
                            throws java.io.IOException

Description copied from interface: CustomersApi

Deletes a customer and all of its cards. You will not be able to recover them.

Specified by:

delete in interface CustomersApi

Parameters:

customerToken - The customer token specified.

Returns:

The deletion result.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

listCharges

public final ChargeListResponse listCharges(java.lang.String customerToken,
                                            int page)
                                     throws java.io.IOException

Description copied from interface: CustomersApi

Returns a paginated list of a customer’s charges.

Specified by:

listCharges in interface CustomersApi

Parameters:

customerToken - The customer token specified.

page - The page number specified.

Returns:

A paginated list of a customer’s charges.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

listCards

public final CardListResponse listCards(java.lang.String customerToken,
                                        int page)
                                 throws java.io.IOException

Description copied from interface: CustomersApi

Returns a paginated list of a customer’s cards.

Specified by:

listCards in interface CustomersApi

Parameters:

customerToken - The customer token specified.

page - The page number specified.

Returns:

A paginated list of a customer’s cards.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

createCard

public final CardResponse createCard(java.lang.String customerToken,
                                     Card card)
                              throws java.io.IOException

Description copied from interface: CustomersApi

Creates an additional card for the specified customer and returns its details. The customer’s primary card will not be changed by this operation.

Specified by:

createCard in interface CustomersApi

Parameters:

customerToken - The customer token specified.

card - The card specified.

Returns:

The details of the card specified.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

deleteCard

public final DeletionResult deleteCard(java.lang.String customerToken,
                                       java.lang.String cardToken)
                                throws java.io.IOException

Description copied from interface: CustomersApi

Deletes a customer’s non-primary card. You will not be able to recover it.

Specified by:

deleteCard in interface CustomersApi

Parameters:

customerToken - The customer token specified.

cardToken - The card token specified.

Returns:

The deletion result.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

getApiName

protected final java.lang.String getApiName()

Specified by:

getApiName in class AbstractBaseApi