On this page
No Headings
Information needed to pay using Google Pay.
objectnameobject^[\S\s]*$The full name representation like Mr J Smith.
Name on the account holder associated with Google 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 Google Pay.
phone_numberobjectA structured representation of a phone number conforming to the international E.164 numbering plan format,requiring the national_number field and optionally supporting the country_code.
The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.
country_codestring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the 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).
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).
cardobjectThe payment card used to fund a Google Pay payment. Can be a credit or debit card.
The payment card information.
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.
last_digitsstring^[0-9]{2,4}$The last digits of the payment card.
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.
decrypted_tokenobjectDetails shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method.
The decrypted payload details for the Google Pay token.
message_idstring^.*$A unique ID that identifies the message in case it needs to be revoked or located at a later time.
message_expirationstring^\d{13}$Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.
payment_methodrequiredstring"CARD"The type of the payment credential. Currently, only CARD is supported.
cardrequiredobjectGoogle Pay tokenized credit card used to pay.
namestring^.{1,300}$The card holder's name as it appears on the card.
numberrequiredstring^[0-9]{13,19}$The primary account number (PAN) for the payment card.
expiryrequiredobject^[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.
last_digitsstring^[0-9]{2,4}$The last digits of the payment card.
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.
authentication_methodrequiredstring"PAN_ONLY", "CRYPTOGRAM_3DS"Authentication Method which is used for the card transaction.
cryptogramstring^[\S\s]*$Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS.
eci_indicatorstring^.*$Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request.
assurance_detailsobjectInformation about cardholder possession validation and cardholder identification and verifications (ID&V).
Information about what validation has been performed on the returned payment credentials.
account_verifiedbooleanfalseIf true, indicates that Cardholder possession validation has been performed on returned payment credential.
card_holder_authenticatedbooleanfalseIf true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.If false, the same risk-based authentication can be performed as you would for card transactions. This risk-based authentication can include, but not limited to, step-up with 3D Secure protocol if applicable.
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.