org.wisepersist.pinpayments.api

Interface CustomersApi

All Known Implementing Classes:

CustomersApiImpl

public interface CustomersApi

The customers API allows you to store a customer’s email and credit card details. A customer can then be used with the charges API to create multiple charges over time.

Customers can have multiple cards associated with them, and one will be considered the customer’s primary card. The card object in returned customer information represents this primary card. It contains a member called primary, which says whether the card is a customer’s primary card; its value will always be true.

See Also:

Customers API

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.
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.

Method Detail

create

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

Creates a new customer and returns its details.

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

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

Returns a paginated list of all customers.

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

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

Returns the details of a customer.

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

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

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.

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

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

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

Parameters:

customerToken - The customer token specified.

Returns:

The deletion result.

Throws:

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

listCharges

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

Returns a paginated list of a customer’s charges.

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

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

Returns a paginated list of a customer’s cards.

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

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

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

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

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

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

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.