On this page
No Headings
The details about a saved payment source.
objectidstring^[\S\s]*$The PayPal-generated ID for the saved payment source.
statusstring"VAULTED", "CREATED", "APPROVED"The vault status.
customerobjectThis object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
idstring^[0-9a-zA-Z_-]+$The unique ID for a customer generated by PayPal.
email_addressobject^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]).*$The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.
phoneobjectThe phone information.
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.
phone_typestring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
phone_numberrequiredobjectA structured representation of a phone number conforming to the international E.164 numbering plan format,requiring only the national_number field.
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
nameobjectThe name of the party.
The full name of the customer as provided to the merchant or on file with the merchant.
prefixstring^[\S\s]*$The prefix, or title, to the party's name.
given_namestring^[\S\s]*$When the party is a person, the party's given, or first, name.
surnamestring^[\S\s]*$When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestring^[\S\s]*$When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstring^[\S\s]*$The suffix for the party's name.
full_namestring^[\S\s]*$When the party is a person, the party's full name.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
A request-related HATEOAS link.
hrefrequiredstring^[\S\s]*$The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstring^[\S\s]*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
titlestring^[\S\s]*$The link title.
mediaTypestring^[\S\s]*$The media type, as defined by RFC 2046. Describes the link target.
encTypestring^[\S\s]*$"application/json"The media type in which to submit the request data.
schemaobjectThe request data or link target.
The schema that describes the request data.
additionalItemsobjectAny additional items.
dependenciesobjectThe dependencies.
itemsobjectAn item.
definitionsobjectDefinitions.
patternPropertiesobjectThe pattern properties.
propertiesobjectThe properties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
targetSchemaobjectThe request data or link target.
The schema that describes the link target.
additionalItemsobjectAny additional items.
dependenciesobjectThe dependencies.
itemsobjectAn item.
definitionsobjectDefinitions.
patternPropertiesobjectThe pattern properties.
propertiesobjectThe properties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.