On this page
No Headings
Information needed to pay using ApplePay.
objectidstring^.*$ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
nameobject^[\S\s]*$The full name representation like Mr J Smith.
Name on the account holder associated with apple pay.
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])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-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 account holder associated with apple pay.
phone_numberobjectA 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).
decrypted_tokenobjectInformation about the Payment data obtained by decrypting Apple Pay token.
The decrypted payload details for the apple pay token.
transaction_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The transaction amount for the payment that the payer has approved on apple platform.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tokenized_cardrequiredobjectThe payment card to use to fund a payment. Can be a credit or debit card.
Apple Pay tokenized credit card used to pay.
idobject^[A-Za-z0-9-_.+=]+$The identifier of the instrument.
The PayPal-generated ID for the card.
namestring^.{1,300}$The card holder's name as it appears on the card.
numberstring^[0-9]{13,19}$The primary account number (PAN) for the payment card.
expiryobject^[0-9]{4}-(0[1-9]|1[0-2])$The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
The card expiration year and month, in Internet date format For example: 2028-04
security_codestring^[0-9]{3,4}$The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.
last_digitsstring^[0-9]{2,4}$The last digits of the payment card.
card_typeobject"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"The card network or brand. Applies to credit, debit, gift, and payment cards.
The card brand or network. Typically used in the response. DEPRECATED
| See |
|---|
| type |
typeobject"CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"Type of card. i.e Credit, Debit and so on.
The payment card type.
brandobject"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"The card network or brand. Applies to credit, debit, gift, and payment cards.
The card brand or network. Typically used in the response.
billing_addressobjectThe portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
address_line_1string^[\S\s]*$The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.
address_line_2string^[\S\s]*$The second line of the address, for example, a suite or apartment number.
address_line_3string^[\S\s]*$The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4string^[\S\s]*$The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3string^[\S\s]*$The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:
admin_area_2string^[\S\s]*$A city, town, or village. Smaller than admin_area_level_1.
admin_area_1string^[\S\s]*$The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
postal_codestring^[\S\s]*$The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstring^([A-Z]{2}|C2)$The 2-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.
address_detailsobjectThe non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.
street_numberstring^[\S\s]*$The street number.
street_namestring^[\S\s]*$The street name. Just Drury in Drury Lane.
street_typestring^[\S\s]*$The street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestring^[\S\s]*$The delivery service. Post office box, bag number, or post office name.
building_namestring^[\S\s]*$A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstring^[\S\s]*$The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
attributesobjectAdditional attributes associated with the use of this card.
Additional attributes associated with the use of this card.
customerobjectThe details about a customer in PayPal's system of record.
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.
merchant_customer_idstring^[0-9a-zA-Z-_.^*$@#]+$Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.
vaultobjectBasic vault instruction specification that can be extended by specific payment sources that supports vaulting.
Instruction to vault the card based on the specified strategy.
store_in_vaultstring"ON_SUCCESS"Defines how and when the payment source gets vaulted.
verificationobjectThe API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).
Instruction to optionally verify the card based on the specified strategy.
methodstring"SCA_ALWAYS", "SCA_WHEN_REQUIRED", "3D_SECURE", "AVS_CVV""SCA_WHEN_REQUIRED"The method used for card verification.
device_manufacturer_idstring^.*$Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.
payment_data_typestring"3DSECURE", "EMV"Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.
payment_dataobjectInformation about the decrypted apple pay payment data for the token like cryptogram, eci indicator.
Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.
cryptogramstring^.*$Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.
eci_indicatorstring^.*$ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.
emv_datastring^.*$Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.
pinstring^.*$Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.
stored_credentialobjectProvides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.usage=FIRST is compatible only with payment_initiator=CUSTOMER.previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.previous_transaction_reference and previous_network_transaction_reference - can be present in the request.payment_initiatorrequiredstring"CUSTOMER", "MERCHANT"The person or party who initiated or triggered the payment.
payment_typerequiredstring"ONE_TIME", "RECURRING", "UNSCHEDULED"Indicates the type of the stored payment_source payment.
usagestring"FIRST", "SUBSEQUENT", "DERIVED""DERIVED"Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
previous_network_transaction_referenceobjectReference values used by the card network to identify a transaction.
idrequiredstring^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
datestring^[0-9]+$The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the previous_network_transaction_reference_id is passed.
networkobject"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"The card network or brand. Applies to credit, debit, gift, and payment cards.
Name of the card network through which the transaction was routed.
acquirer_reference_numberstring^[a-zA-Z0-9]+$Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
vault_idobject^[0-9a-zA-Z_-]+$The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
The PayPal-generated ID for the saved apple pay payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
attributesobjectAdditional attributes associated with apple pay.
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.
vaultobjectBase vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.
store_in_vaultrequiredstring"ON_SUCCESS"Defines how and when the payment source gets vaulted.
experience_contextobjectCustomizes the payer experience during the approval process for the payment.
return_urlrequiredobjecturiDescribes the URL.
The URL where the customer is redirected after the customer approves the payment.
cancel_urlrequiredobjecturiDescribes the URL.
The URL where the customer is redirected after the customer cancels the payment.