On this page
No Headings
Eligible payment methods along with applicable vault tokens, if requested.
objecteligible_methodsobjectList of payment methods.
List of payment methods that are eligible.
paypalobjectResponse for PayPal.
PayPal payment method.
venmoobjectResponse for Venmo.
Venmo payment method.
paypal_creditobjectCommon response fields for all payment methods.
PayPal Credit payment method.
can_be_vaultedboolean"false"Indicates if the payment method can be vaulted or not. A true value indicates the payment method can be vaulted using our vaults product. If false, vaulting is not currently supported for this payment method.
country_codeobject^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Returns a country_code which is derived from the buyer's country.
product_codeobject"CREDIT", "PAYLATER", "PAY_IN_3", "PAY_IN_4"The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.
Returns a product code.
paypal_pay_laterobjectCommon response fields for all payment methods.
PayPal Pay Later payment method.
can_be_vaultedboolean"false"Indicates if the payment method can be vaulted or not. A true value indicates the payment method can be vaulted using our vaults product. If false, vaulting is not currently supported for this payment method.
country_codeobject^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Returns a country_code which is derived from the buyer's country.
product_codeobject"CREDIT", "PAYLATER", "PAY_IN_3", "PAY_IN_4"The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.
Returns a product code.
payment_tokensarrayPayment tokens for vaulted instruments, if available. This object will be included only if include_vault_tokens is set to true in the request.
itemsobjectVaulted instrument for a payment-method.
Payment Token.
idstring^[0-9a-zA-Z_-]+$The PayPal-generated ID for the vault token.
payment_sourceobjectThe vaulted payment method details.
paypalobjectThe customer who approves and pays for the order. The customer is also known as the payer.
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.
The email address of the payer.
payer_idobject^[2-9A-HJ-NP-Z]{13}$The account identifier for a PayPal account.
The PayPal-assigned ID for the payer.
venmoobjectPayment Token info for Venmo payment source.
user_namestring^[-a-zA-Z0-9_]*$The Venmo username, as chosen by the user.
linksarrayAn array of related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
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.