card_request

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.

card_typeenum<card_brand>OptionalDeprecated

The card brand or network. Typically used in the response. DEPRECATED

See
type

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

billing_addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^[\S\s]*$Length0 <= length <= 60

address_detailsobject<Address Details>Optional

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

stored_credentialobject<card_stored_credential>Optional

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.

card_stored_credential properties

4 properties

previous_network_transaction_referenceobject<network_transaction_reference>Optional

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

network_tokenobject<network_token_request>Optional

The Third Party Network token used to fund a payment.

experience_contextobject<card_experience_context>Optional

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

See

type

card_request

address_portable properties

Address Details properties

card_attributes properties

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

card_stored_credential properties

network_transaction_reference properties

network_token_request properties

card_experience_context properties

Back to top

On this page

On this page

card_request

address_portable properties

Address Details properties

card_attributes properties

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

card_stored_credential properties

network_transaction_reference properties

network_token_request properties

card_experience_context properties

Back to top

On this page

card_request

address_portable properties

Address Details properties

card_attributes properties

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

card_stored_credential properties

network_transaction_reference properties

network_token_request properties

card_experience_context properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

card_request

address_portable properties

Address Details properties

card_attributes properties

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_instruction_base properties

card_verification properties

card_stored_credential properties

network_transaction_reference properties

network_token_request properties

card_experience_context properties

Back to top

On this page