POST /v2/checkout/orders/{id}/capture

The ID of the order that the tracking information is associated with.

Default value: "application/json"

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).

The preferred server response upon successful completion of the request. Value is:

• return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
• return=representation. The server returns a complete resource representation, including the current state of the resource.

Default value: "return=minimal"

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

The payment source definition.

Information needed to pay using Swish.

The full name representation like Mr J Smith.

Customizes the payer experience during the approval process for the payment.

Describes the URL.

The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

The location from which the shipping address is derived.

Possible values:

• "GET_FROM_FILE"
• "NO_SHIPPING"
• "SET_PROVIDED_ADDRESS"

Default value: "GET_FROM_FILE"

Describes the URL.

The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.

Describes the URL.

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Information needed to pay using Google Pay.

The full name representation like Mr J Smith.

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.

Customizes the payer experience during the approval process for the payment.

Describes the URL.

Describes the URL.

Details shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method.

A unique ID that identifies the message in case it needs to be revoked or located at a later time.

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.

Authentication Method which is used for the card transaction.

Possible values:

• "CRYPTOGRAM_3DS"
• "PAN_ONLY"

Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.

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.

The type of the payment credential. Currently, only CARD is supported.

Possible values:

• "CARD"

The payment card used to fund a Google Pay payment. Can be a credit or debit card.

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

The last digits of the payment card.

The card network or brand. Applies to credit, debit, gift, and payment cards.

Possible values:

• "CB_NATIONALE"
• "PULSE"
• "ELO"
• "NYCE"
• "STAR"
• "CONFIDIS"
• "SYNCHRONY"
• "CONFIGOGA"
• "CHINA_UNION_PAY"
• "DELTA"
• "SWITCH"
• "DISCOVER"
• "MAESTRO"
• "MASTERCARD"
• "ELECTRON"
• "HIPERCARD"
• "RUPAY"
• "DINERS"
• "EFTPOS"
• "CARTE_BANCAIRE"
• "HIPER"
• "GE"
• "ACCEL"
• "STAR_ACCESS"
• "UNKNOWN"
• "CETELEM"
• "SOLO"
• "JCB"
• "VISA"
• "AMEX"

Type of card. i.e Credit, Debit and so on.

Possible values:

• "DEBIT"
• "CREDIT"
• "UNKNOWN"
• "STORE"
• "PREPAID"

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

A city, town, or village. Smaller than admin_area_level_1.

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

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:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The second line of the address, for example, a suite or apartment number.

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.

The payment card used to fund a Google Pay payment. Can be a credit or debit card.

The card holder's name as it appears on the card.

The card network or brand. Applies to credit, debit, gift, and payment cards.

Possible values:

• "CB_NATIONALE"
• "PULSE"
• "ELO"
• "NYCE"
• "STAR"
• "CONFIDIS"
• "SYNCHRONY"
• "CONFIGOGA"
• "CHINA_UNION_PAY"
• "DELTA"
• "SWITCH"
• "DISCOVER"
• "MAESTRO"
• "MASTERCARD"
• "ELECTRON"
• "HIPERCARD"
• "RUPAY"
• "DINERS"
• "EFTPOS"
• "CARTE_BANCAIRE"
• "HIPER"
• "GE"
• "ACCEL"
• "STAR_ACCESS"
• "UNKNOWN"
• "CETELEM"
• "SOLO"
• "JCB"
• "VISA"
• "AMEX"

Type of card. i.e Credit, Debit and so on.

Possible values:

• "DEBIT"
• "CREDIT"
• "UNKNOWN"
• "STORE"
• "PREPAID"

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

A city, town, or village. Smaller than admin_area_level_1.

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

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:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The second line of the address, for example, a suite or apartment number.

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.

Information about cardholder possession validation and cardholder identification and verifications (ID&V).

If true, indicates that Cardholder possession validation has been performed on returned payment credential.

Default value: false

If 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.

Default value: false

The phone number in its canonical international E.164 numbering plan format.

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).

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).

Information needed to pay using Pix.

The tax ID of the customer. The customer is also known as the payer. Both tax_id and tax_id_type are required.

The customer's tax ID type.

Possible values:

• "BR_CNPJ"
• "BR_CPF"

The customer's tax ID value.

The full name representation like Mr J Smith.

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 3-character ISO-4217 currency code that identifies the currency.

QR details received from processor.

QR image received from APM processor, The pattern is not provided because the value is defined by an external party.

QR Expiry time in seconds

QR payload received from APM processor, The pattern is not provided because the value is defined by an external party.

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

The phone number in its canonical international E.164 numbering plan format.

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).

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).

A resource that identifies a PayPal Wallet is used for payment.

The tax ID of the customer. The customer is also known as the payer. Both tax_id and tax_id_type are required.

The customer's tax ID type.

Possible values:

• "BR_CNPJ"
• "BR_CPF"

The customer's tax ID value.

Additional attributes associated with the use of this PayPal Wallet.

The details about a customer in PayPal's system of record.

The unique ID for a customer generated by PayPal.

The name of the party.

When the party is a person, the party's given, or first, name.

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.

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 phone information.

The phone type.

Possible values:

• "OTHER"
• "HOME"
• "MOBILE"
• "FAX"
• "PAGER"

The phone number, in its canonical international E.164 numbering plan format.

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).

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.

The name of the party.

When the party is a person, the party's given, or first, name.

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.

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.

Customizes the payer experience during the approval process for payment with PayPal.

Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.

The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

The type of landing page to show on the PayPal site for customer checkout.

Possible values:

• "LOGIN"
• "GUEST_CHECKOUT"
• "NO_PREFERENCE"

Default value: "NO_PREFERENCE"

The location from which the shipping address is derived.

Possible values:

• "GET_FROM_FILE"
• "NO_SHIPPING"
• "SET_PROVIDED_ADDRESS"

Default value: "GET_FROM_FILE"

The preference to display the contact information (buyer’s shipping email & phone number) on PayPal's checkout for easy merchant-buyer communication.

Possible values:

• "NO_CONTACT_INFO"
• "RETAIN_CONTACT_INFO"
• "UPDATE_CONTACT_INFO"

Default value: "NO_CONTACT_INFO"

CallBack Configuration that the merchant can provide to PayPal/Venmo.

An array of callback events merchant can subscribe to for the corresponding callback url.

Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the cart id or other params part of the url as query or path params.

Configures a Continue or Pay Now checkout flow.

Possible values:

• "CONTINUE"
• "PAY_NOW"

Default value: "CONTINUE"

Describes the URL.

The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.

Describes the URL.

The merchant-preferred payment methods.

Possible values:

• "UNRESTRICTED"
• "IMMEDIATE_PAYMENT_REQUIRED"

Default value: "UNRESTRICTED"

The phone information.

The phone type.

Possible values:

• "OTHER"
• "HOME"
• "MOBILE"
• "FAX"
• "PAGER"

The phone number, in its canonical international E.164 numbering plan format.

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).

The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

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 billing agreement ID. References an approved recurring payment for goods or services.

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

A city, town, or village. Smaller than admin_area_level_1.

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

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:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The second line of the address, for example, a suite or apartment number.

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.

Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.

The person or party who initiated or triggered the payment.

Possible values:

• "CUSTOMER"
• "MERCHANT"

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values:

• "SUBSEQUENT"
• "FIRST"
• "DERIVED"

Default value: "DERIVED"

Expected business/pricing model for the billing agreement.

Possible values:

• "RECURRING_POSTPAID"
• "UNSCHEDULED_PREPAID"
• "IMMEDIATE"
• "THRESHOLD_POSTPAID"
• "SUBSCRIPTION_PREPAID"
• "INSTALLMENT_PREPAID"
• "DEFERRED"
• "THRESHOLD_PREPAID"
• "UNSCHEDULED_POSTPAID"
• "INSTALLMENT_POSTPAID"
• "RECURRING_PREPAID"
• "SUBSCRIPTION_POSTPAID"

Expected business/pricing model for the billing agreement.

Possible values:

• "RECURRING_POSTPAID"
• "UNSCHEDULED_PREPAID"
• "IMMEDIATE"
• "THRESHOLD_POSTPAID"
• "SUBSCRIPTION_PREPAID"
• "INSTALLMENT_PREPAID"
• "DEFERRED"
• "THRESHOLD_PREPAID"
• "UNSCHEDULED_POSTPAID"
• "INSTALLMENT_POSTPAID"
• "RECURRING_PREPAID"
• "SUBSCRIPTION_POSTPAID"

The tokenized payment source to fund a payment.

The PayPal-generated ID for the token.

The tokenization method that generated the ID.

Possible values:

• "BILLING_AGREEMENT"

Information needed to pay using Venmo.

Additional attributes associated with the use of this Venmo Wallet.

This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.

The unique ID for a customer generated by PayPal.

The name of the party.

When the party is a person, the party's given, or first, name.

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.

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 phone information.

The phone type.

Possible values:

• "OTHER"
• "HOME"
• "MOBILE"
• "FAX"
• "PAGER"

The phone number, in its canonical international E.164 numbering plan format.

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).

Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.

The usage type associated with the Venmo payment token.

Possible values:

• "PLATFORM"
• "MERCHANT"

Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same Venmo account.

Default value: false

Defines how and when the payment source gets vaulted.

Possible values:

• "ON_SUCCESS"

The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.

The customer type associated with the Venmo payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

Possible values:

• "CONSUMER"
• "BUSINESS"

Default value: "CONSUMER"

Expected business/pricing model for the billing agreement.

Possible values:

• "RECURRING_POSTPAID"
• "IMMEDIATE"
• "THRESHOLD_POSTPAID"
• "DEFERRED"
• "THRESHOLD_PREPAID"
• "RECURRING_PREPAID"

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.

Customizes the buyer experience during the approval process for payment with Venmo.

Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.

The business name of the merchant. The pattern is defined by an external party and supports Unicode.

The location from which the shipping address is derived.

Possible values:

• "GET_FROM_FILE"
• "NO_SHIPPING"
• "SET_PROVIDED_ADDRESS"

Default value: "GET_FROM_FILE"

CallBack Configuration that the merchant can provide to PayPal/Venmo.

An array of callback events merchant can subscribe to for the corresponding callback url.

Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the cart id or other params part of the url as query or path params.

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 payment card to use to fund a payment. Can be a credit or debit card.

Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

Additional attributes associated with the use of this card.

The details about a customer in PayPal's system of record.

The unique ID for a customer generated by PayPal.

The name of the party.

When the party is a person, the party's given, or first, name.

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.

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 phone information.

The phone type.

Possible values:

• "OTHER"
• "HOME"
• "MOBILE"
• "FAX"
• "PAGER"

The phone number, in its canonical international E.164 numbering plan format.

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).

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.

The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).

The method used for card verification.

Possible values:

• "SCA_WHEN_REQUIRED"
• "3D_SECURE"
• "AVS_CVV"
• "SCA_ALWAYS"

Default value: "SCA_WHEN_REQUIRED"

Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.

Defines how and when the payment source gets vaulted.

Possible values:

• "ON_SUCCESS"

The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.

The card holder's name as it appears on the card.

Customizes the payer experience during the 3DS Approval for payment.

Describes the URL.

Describes the URL.

The primary account number (PAN) for the payment card.

The Third Party Network token used to fund a payment.

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.

Possible values:

• "NON_3D_SECURE_TRANSACTION"
• "ATTEMPTED_AUTHENTICATION_TRANSACTION"
• "MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION"
• "FULLY_AUTHENTICATED_TRANSACTION"
• "MASTERCARD_NON_3D_SECURE_TRANSACTION"
• "MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION"

Third party network token number.

A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.

An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.

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 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.

Provides 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.
• Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

The person or party who initiated or triggered the payment.

Possible values:

• "CUSTOMER"
• "MERCHANT"

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values:

• "SUBSEQUENT"
• "FIRST"
• "DERIVED"

Default value: "DERIVED"

Indicates the type of the stored payment_source payment.

Possible values:

• "UNSCHEDULED"
• "RECURRING"
• "ONE_TIME"

Reference values used by the card network to identify a transaction.

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 -.

The card network or brand. Applies to credit, debit, gift, and payment cards.

Possible values:

• "CB_NATIONALE"
• "PULSE"
• "ELO"
• "NYCE"
• "STAR"
• "CONFIDIS"
• "SYNCHRONY"
• "CONFIGOGA"
• "CHINA_UNION_PAY"
• "DELTA"
• "SWITCH"
• "DISCOVER"
• "MAESTRO"
• "MASTERCARD"
• "ELECTRON"
• "HIPERCARD"
• "RUPAY"
• "DINERS"
• "EFTPOS"
• "CARTE_BANCAIRE"
• "HIPER"
• "GE"
• "ACCEL"
• "STAR_ACCESS"
• "UNKNOWN"
• "CETELEM"
• "SOLO"
• "JCB"
• "VISA"
• "AMEX"

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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.

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

A city, town, or village. Smaller than admin_area_level_1.

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

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:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The second line of the address, for example, a suite or apartment number.

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.

Information needed to pay using ApplePay.

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.

Additional attributes associated with apple pay.

This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.

The unique ID for a customer generated by PayPal.

The name of the party.

When the party is a person, the party's given, or first, name.

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.

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 phone information.

The phone type.

Possible values:

• "OTHER"
• "HOME"
• "MOBILE"
• "FAX"
• "PAGER"

The phone number, in its canonical international E.164 numbering plan format.

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).

Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.

Defines how and when the payment source gets vaulted.

Possible values:

• "ON_SUCCESS"

The full name representation like Mr J Smith.

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.

Customizes the payer experience during the approval process for the payment.

Describes the URL.

Describes the URL.

Information about the Payment data obtained by decrypting Apple Pay token.

The currency and amount for a financial transaction, such as a balance or payment due.

The three-character ISO-4217 currency code that identifies the currency.

The value, which might be:

• An integer for currencies like JPY that are not typically fractional.
• A decimal fraction for currencies like TND that are subdivided into thousandths.

Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.

Possible values:

• "3DSECURE"
• "EMV"

Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.

ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.

Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.

Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.

Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.

The payment card to use to fund a payment. Can be a credit or debit card.

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

The card network or brand. Applies to credit, debit, gift, and payment cards.

Possible values:

• "CB_NATIONALE"
• "PULSE"
• "ELO"
• "NYCE"
• "STAR"
• "CONFIDIS"
• "SYNCHRONY"
• "CONFIGOGA"
• "CHINA_UNION_PAY"
• "DELTA"
• "SWITCH"
• "DISCOVER"
• "MAESTRO"
• "MASTERCARD"
• "ELECTRON"
• "HIPERCARD"
• "RUPAY"
• "DINERS"
• "EFTPOS"
• "CARTE_BANCAIRE"
• "HIPER"
• "GE"
• "ACCEL"
• "STAR_ACCESS"
• "UNKNOWN"
• "CETELEM"
• "SOLO"
• "JCB"
• "VISA"
• "AMEX"

Type of card. i.e Credit, Debit and so on.

Possible values:

• "DEBIT"
• "CREDIT"
• "UNKNOWN"
• "STORE"
• "PREPAID"

The card network or brand. Applies to credit, debit, gift, and payment cards.

Possible values:

• "CB_NATIONALE"
• "PULSE"
• "ELO"
• "NYCE"
• "STAR"
• "CONFIDIS"
• "SYNCHRONY"
• "CONFIGOGA"
• "CHINA_UNION_PAY"
• "DELTA"
• "SWITCH"
• "DISCOVER"
• "MAESTRO"
• "MASTERCARD"
• "ELECTRON"
• "HIPERCARD"
• "RUPAY"
• "DINERS"
• "EFTPOS"
• "CARTE_BANCAIRE"
• "HIPER"
• "GE"
• "ACCEL"
• "STAR_ACCESS"
• "UNKNOWN"
• "CETELEM"
• "SOLO"
• "JCB"
• "VISA"
• "AMEX"

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

A city, town, or village. Smaller than admin_area_level_1.

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

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:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

The second line of the address, for example, a suite or apartment number.

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.

Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.

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.

Provides 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.
• Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

The person or party who initiated or triggered the payment.

Possible values:

• "CUSTOMER"
• "MERCHANT"

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values:

• "SUBSEQUENT"
• "FIRST"
• "DERIVED"

Default value: "DERIVED"

Indicates the type of the stored payment_source payment.

Possible values:

• "UNSCHEDULED"
• "RECURRING"
• "ONE_TIME"

Reference values used by the card network to identify a transaction.

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 -.

The card network or brand. Applies to credit, debit, gift, and payment cards.

Possible values:

• "CB_NATIONALE"
• "PULSE"
• "ELO"
• "NYCE"
• "STAR"
• "CONFIDIS"
• "SYNCHRONY"
• "CONFIGOGA"
• "CHINA_UNION_PAY"
• "DELTA"
• "SWITCH"
• "DISCOVER"
• "MAESTRO"
• "MASTERCARD"
• "ELECTRON"
• "HIPERCARD"
• "RUPAY"
• "DINERS"
• "EFTPOS"
• "CARTE_BANCAIRE"
• "HIPER"
• "GE"
• "ACCEL"
• "STAR_ACCESS"
• "UNKNOWN"
• "CETELEM"
• "SOLO"
• "JCB"
• "VISA"
• "AMEX"

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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.

The phone number, in its canonical international E.164 numbering plan format.

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).