Order Capture Request

Completes an capture payment for an order.

payment_sourceobject<payment_source>Optional

The payment source definition.

payment_source properties

16 properties

cardobject<card_request>Optional

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_request properties

16 properties

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.

paypalobject<paypal_wallet>Optional

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

paypal_wallet properties

11 properties

email_addressstring<email>Optional

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.

Match^.*(?:[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])+)\]).*$Length3 <= length <= 254

nameobject<name>Optional

The name of the party.

birth_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). 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.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

addressobject<address_portable>Optional

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

experience_contextobject<paypal_wallet_experience_context>Optional

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.

paypal_wallet_experience_context properties

11 properties

brand_namestringOptional

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.

Match^.*$Length1 <= length <= 127

localestring<language>Optional

The [language tag](https://tools.ietf.org/html/bcp47#section-2) 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](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

shipping_preferenceenumOptional

The location from which the shipping address is derived.

Default"GET_FROM_FILE"Value in"GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS"

contact_preferenceenumOptional

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

Default"NO_CONTACT_INFO"Value in"NO_CONTACT_INFO" | "UPDATE_CONTACT_INFO" | "RETAIN_CONTACT_INFO"

return_urlstring<url>Optional

Describes the URL.

FormaturiLength0 <= length <= 2147483647

cancel_urlstring<url>Optional

Describes the URL.

FormaturiLength0 <= length <= 2147483647

app_switch_contextobject<app_switch_context>Optional

Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.

landing_pageenumOptional

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

Default"NO_PREFERENCE"Value in"LOGIN" | "GUEST_CHECKOUT" | "NO_PREFERENCE" | "BILLING"

user_actionenumOptional

Configures a Continue or Pay Now checkout flow.

Default"CONTINUE"Value in"CONTINUE" | "PAY_NOW"

payment_method_preferenceenumOptional

The merchant-preferred payment methods.

Default"UNRESTRICTED"Value in"UNRESTRICTED" | "IMMEDIATE_PAYMENT_REQUIRED"

order_update_callback_configobject<callback_configuration>Optional

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

stored_credentialobject<paypal_wallet_stored_credential>Optional

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.

paypal_wallet_stored_credential properties

4 properties

charge_patternenum<charge_pattern>OptionalDeprecated

DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead. DEPRECATED

See
usage_pattern

Expected business/pricing model for the billing agreement.

apple_payobject<apple_pay_request>Optional

Information needed to pay using ApplePay.

apple_pay_request properties

9 properties

email_addressstring<email_address>Optional

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.

Match^(?:[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])+)\])$Length3 <= length <= 254

phone_numberobject<phone_number_without_country_code>Optional

A structured representation of a phone number conforming to the international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en),requiring only the national_number field.

decrypted_tokenobject<apple_pay_decrypted_token_data>Optional

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

apple_pay_decrypted_token_data properties

5 properties

transaction_amountobject<money>Optional

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

tokenized_cardobject<card>Required

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

card properties

11 properties

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

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

payment_dataobject<apple_pay_payment_data>Optional

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

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.

experience_contextobject<apple_pay_experience_context>Optional

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

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

Order Capture Request

payment_source properties

card_request properties

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

token properties

paypal_wallet properties

name properties

phone_with_type properties

phone_number_without_country_code properties

tax_info properties

address_portable properties

Address Details properties

paypal_wallet_attributes properties

paypal_wallet_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

vault_paypal_wallet_base properties

shipping_detail properties

name properties

phone properties

shipping_option properties

money properties

address_portable properties

Address Details properties

paypal_wallet_experience_context properties

app_switch_context properties

native_app_context properties

mobile_web_context properties

callback_configuration properties

paypal_wallet_stored_credential properties

bancontact_request properties

experience_context_base properties

blik_request properties

blik_experience_context properties

blik_seamless properties

blik_one_click properties

eps_request properties

experience_context_base properties

giropay_request properties

experience_context_base properties

ideal_request properties

experience_context_base properties

mybank_request properties

experience_context_base properties

p24_request properties

experience_context_base properties

sofort_request properties

experience_context_base properties

trustly_request properties

experience_context_base properties

apple_pay_request properties

phone_number_without_country_code properties

apple_pay_decrypted_token_data properties

money properties

card properties

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

apple_pay_payment_data properties