com.paypal.sdk.controllers

Class VaultController

java.lang.Object

com.paypal.sdk.controllers.BaseController

com.paypal.sdk.controllers.VaultController

public final class VaultController
extends BaseController

This class lists all the endpoints of the groups.

Field Summary

Fields inherited from class com.paypal.sdk.controllers.BaseController

GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Constructor and Description
VaultController(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

Method Summary

Modifier and Type	Method and Description
ApiResponse<PaymentTokenResponse>	createPaymentToken(CreatePaymentTokenInput input) Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
CompletableFuture<ApiResponse<PaymentTokenResponse>>	createPaymentTokenAsync(CreatePaymentTokenInput input) Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
ApiResponse<SetupTokenResponse>	createSetupToken(CreateSetupTokenInput input) Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
CompletableFuture<ApiResponse<SetupTokenResponse>>	createSetupTokenAsync(CreateSetupTokenInput input) Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
ApiResponse<Void>	deletePaymentToken(String id) Delete the payment token associated with the payment token id.
CompletableFuture<ApiResponse<Void>>	deletePaymentTokenAsync(String id) Delete the payment token associated with the payment token id.
ApiResponse<PaymentTokenResponse>	getPaymentToken(String id) Returns a readable representation of vaulted payment source associated with the payment token id.
CompletableFuture<ApiResponse<PaymentTokenResponse>>	getPaymentTokenAsync(String id) Returns a readable representation of vaulted payment source associated with the payment token id.
ApiResponse<SetupTokenResponse>	getSetupToken(String id) Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
CompletableFuture<ApiResponse<SetupTokenResponse>>	getSetupTokenAsync(String id) Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
ApiResponse<CustomerVaultPaymentTokensResponse>	listCustomerPaymentTokens(ListCustomerPaymentTokensInput input) Returns all payment tokens for a customer.
CompletableFuture<ApiResponse<CustomerVaultPaymentTokensResponse>>	listCustomerPaymentTokensAsync(ListCustomerPaymentTokensInput input) Returns all payment tokens for a customer.

Methods inherited from class com.paypal.sdk.controllers.BaseController

getClientInstance, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultController

public VaultController(io.apimatic.core.GlobalConfiguration globalConfig)

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

Method Detail

createPaymentToken

public ApiResponse<PaymentTokenResponse> createPaymentToken(CreatePaymentTokenInput input)
                                                     throws ApiException,
                                                            IOException

Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.

Parameters:

input - CreatePaymentTokenInput object containing request parameters

Returns:

Returns the PaymentTokenResponse wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createPaymentTokenAsync

public CompletableFuture<ApiResponse<PaymentTokenResponse>> createPaymentTokenAsync(CreatePaymentTokenInput input)

Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.

Parameters:

input - CreatePaymentTokenInput object containing request parameters

Returns:

Returns the PaymentTokenResponse wrapped in ApiResponse response from the API call

listCustomerPaymentTokens

public ApiResponse<CustomerVaultPaymentTokensResponse> listCustomerPaymentTokens(ListCustomerPaymentTokensInput input)
                                                                          throws ApiException,
                                                                                 IOException

Returns all payment tokens for a customer.

Parameters:

input - ListCustomerPaymentTokensInput object containing request parameters

Returns:

Returns the CustomerVaultPaymentTokensResponse wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listCustomerPaymentTokensAsync

public CompletableFuture<ApiResponse<CustomerVaultPaymentTokensResponse>> listCustomerPaymentTokensAsync(ListCustomerPaymentTokensInput input)

Returns all payment tokens for a customer.

Parameters:

input - ListCustomerPaymentTokensInput object containing request parameters

Returns:

Returns the CustomerVaultPaymentTokensResponse wrapped in ApiResponse response from the API call

getPaymentToken

public ApiResponse<PaymentTokenResponse> getPaymentToken(String id)
                                                  throws ApiException,
                                                         IOException

Returns a readable representation of vaulted payment source associated with the payment token id.

Parameters:

id - Required parameter: ID of the payment token.

Returns:

Returns the PaymentTokenResponse wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getPaymentTokenAsync

public CompletableFuture<ApiResponse<PaymentTokenResponse>> getPaymentTokenAsync(String id)

Returns a readable representation of vaulted payment source associated with the payment token id.

Parameters:

id - Required parameter: ID of the payment token.

Returns:

Returns the PaymentTokenResponse wrapped in ApiResponse response from the API call

deletePaymentToken

public ApiResponse<Void> deletePaymentToken(String id)
                                     throws ApiException,
                                            IOException

Delete the payment token associated with the payment token id.

Parameters:

id - Required parameter: ID of the payment token.

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deletePaymentTokenAsync

public CompletableFuture<ApiResponse<Void>> deletePaymentTokenAsync(String id)

Delete the payment token associated with the payment token id.

Parameters:

id - Required parameter: ID of the payment token.

Returns:

Returns the Void wrapped in ApiResponse response from the API call

createSetupToken

public ApiResponse<SetupTokenResponse> createSetupToken(CreateSetupTokenInput input)
                                                 throws ApiException,
                                                        IOException

Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.

Parameters:

input - CreateSetupTokenInput object containing request parameters

Returns:

Returns the SetupTokenResponse wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createSetupTokenAsync

public CompletableFuture<ApiResponse<SetupTokenResponse>> createSetupTokenAsync(CreateSetupTokenInput input)

Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.

Parameters:

input - CreateSetupTokenInput object containing request parameters

Returns:

Returns the SetupTokenResponse wrapped in ApiResponse response from the API call

getSetupToken

public ApiResponse<SetupTokenResponse> getSetupToken(String id)
                                              throws ApiException,
                                                     IOException

Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

Parameters:

id - Required parameter: ID of the setup token.

Returns:

Returns the SetupTokenResponse wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getSetupTokenAsync

public CompletableFuture<ApiResponse<SetupTokenResponse>> getSetupTokenAsync(String id)

Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

Parameters:

id - Required parameter: ID of the setup token.

Returns:

Returns the SetupTokenResponse wrapped in ApiResponse response from the API call