PayPal-PHP-Server-SDK/doc/controllers/vault.md

Vault

Use the /vault resource to create, retrieve, and delete payment and setup tokens.

$vaultController = $client->getVaultController();

Class Name

VaultController

Methods

• Payment-Tokens Create
• Customer Payment-Tokens Get
• Payment-Tokens Get
• Payment-Tokens Delete
• Setup-Tokens Create
• Setup-Tokens Get

Payment-Tokens Create

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

function paymentTokensCreate(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
payPalRequestId	string	Header, Required	The server stores keys for 3 hours.
body	PaymentTokenRequest	Body, Required	Payment Token creation with a financial instrument and an optional customer_id.

Response Type

This method returns a PayPalRESTAPIsLib\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type PaymentTokenResponse.

Example Usage

$collect = [
    'payPalRequestId' => 'PayPal-Request-Id6',
    'body' => PaymentTokenRequestBuilder::init(
        PaymentTokenRequestPaymentSourceBuilder::init()->build()
    )->build()
];

$apiResponse = $vaultController->paymentTokensCreate($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	ErrorException
403	Authorization failed due to insufficient permissions.	ErrorException
404	Request contains reference to resources that do not exist.	ErrorException
422	The requested action could not be performed, semantically incorrect, or failed business validation.	ErrorException
500	An internal server error has occurred.	ErrorException

Customer Payment-Tokens Get

Returns all payment tokens for a customer.

function customerPaymentTokensGet(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
customerId	string	Query, Required	A unique identifier representing a specific customer in merchant's/partner's system or records.
pageSize	?int	Query, Optional	A non-negative, non-zero integer indicating the maximum number of results to return at one time.
page	?int	Query, Optional	A non-negative, non-zero integer representing the page of the results.
totalRequired	?bool	Query, Optional	A boolean indicating total number of items (total_items) and pages (total_pages) are expected to be returned in the response.

Response Type

This method returns a PayPalRESTAPIsLib\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type CustomerVaultPaymentTokensResponse.

Example Usage

$collect = [
    'customerId' => 'customer_id8',
    'pageSize' => 5,
    'page' => 1,
    'totalRequired' => false
];

$apiResponse = $vaultController->customerPaymentTokensGet($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	ErrorException
403	Authorization failed due to insufficient permissions.	ErrorException
500	An internal server error has occurred.	ErrorException

Payment-Tokens Get

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

function paymentTokensGet(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
id	string	Template, Required	ID of the payment token.

Response Type

This method returns a PayPalRESTAPIsLib\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type PaymentTokenResponse.

Example Usage

$id = 'id0';

$apiResponse = $vaultController->paymentTokensGet($id);

Errors

HTTP Status Code	Error Description	Exception Class
403	Authorization failed due to insufficient permissions.	ErrorException
404	The specified resource does not exist.	ErrorException
422	The requested action could not be performed, semantically incorrect, or failed business validation.	ErrorException
500	An internal server error has occurred.	ErrorException

Payment-Tokens Delete

Delete the payment token associated with the payment token id.

function paymentTokensDelete(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
id	string	Template, Required	ID of the payment token.

Response Type

This method returns a PayPalRESTAPIsLib\Utils\ApiResponse instance.

Example Usage

$id = 'id0';

$apiResponse = $vaultController->paymentTokensDelete($id);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	ErrorException
403	Authorization failed due to insufficient permissions.	ErrorException
500	An internal server error has occurred.	ErrorException

Setup-Tokens Create

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

function setupTokensCreate(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
payPalRequestId	string	Header, Required	The server stores keys for 3 hours.
body	SetupTokenRequest	Body, Required	Setup Token creation with a instrument type optional financial instrument details and customer_id.

Response Type

This method returns a PayPalRESTAPIsLib\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type SetupTokenResponse.

Example Usage

$collect = [
    'payPalRequestId' => 'PayPal-Request-Id6',
    'body' => SetupTokenRequestBuilder::init(
        SetupTokenRequestPaymentSourceBuilder::init()->build()
    )->build()
];

$apiResponse = $vaultController->setupTokensCreate($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	ErrorException
403	Authorization failed due to insufficient permissions.	ErrorException
422	The requested action could not be performed, semantically incorrect, or failed business validation.	ErrorException
500	An internal server error has occurred.	ErrorException

Setup-Tokens Get

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

function setupTokensGet(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
id	string	Template, Required	ID of the setup token.

Response Type

This method returns a PayPalRESTAPIsLib\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type SetupTokenResponse.

Example Usage

$id = 'id0';

$apiResponse = $vaultController->setupTokensGet($id);

Errors

HTTP Status Code	Error Description	Exception Class
403	Authorization failed due to insufficient permissions.	ErrorException
404	The specified resource does not exist.	ErrorException
422	The requested action could not be performed, semantically incorrect, or failed business validation.	ErrorException
500	An internal server error has occurred.	ErrorException