Vault Response

August 21, 2026 · View on GitHub

The details about a saved payment source.

Structure

VaultResponse

Fields

NameTypeTagsDescriptionGetterSetter
IdStringOptionalThe PayPal-generated ID for the saved payment source.

Constraints: Minimum Length: 1, Maximum Length: 255
String getId()setId(String id)
StatusVaultStatusOptionalThe vault status.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$
VaultStatus getStatus()setStatus(VaultStatus status)
CustomerVaultCustomerOptionalThis object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.VaultCustomer getCustomer()setCustomer(VaultCustomer customer)
LinksList<LinkDescription>Optional, Read-onlyAn array of request-related HATEOAS links.

Constraints: Minimum Items: 1, Maximum Items: 10
List getLinks()setLinks(List links)

Example

import com.paypal.sdk.models.Name;
import com.paypal.sdk.models.VaultCustomer;
import com.paypal.sdk.models.VaultResponse;
import com.paypal.sdk.models.VaultStatus;

VaultResponse vaultResponse = new VaultResponse.Builder()
    .id("id2")
    .status(VaultStatus.VAULTED)
    .customer(new VaultCustomer.Builder()
        .id("id0")
        .name(new Name.Builder()
            .givenName("given_name2")
            .surname("surname8")
            .build())
        .build())
    .build();