Order Authorize Response

The order authorize response.

payment_sourceobject<payment_source_response>Optional

The payment source used to fund the payment.

payment_source_response properties

15 properties

paypalobject<paypal_wallet_response>Optional

The PayPal Wallet response.

paypal_wallet_response properties

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

phone_numberobject<phone-3>Optional

The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

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

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

epsobject<eps>Optional

Information used to pay using eps.

giropayobject<giropay>Optional

Information needed to pay using giropay.

p24object<p24>Optional

Information used to pay using P24(Przelewy24).

linksobject<link_description-2>[]Optional

An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.

Items0 <= length <= 32767

link_description-2 properties

8 properties

schemaobject<link_schema-2>Optional

The request data or link target.

targetSchemaobject<link_schema-2>Optional

The request data or link target.

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

payment_source_response properties

card_response properties

authentication_response properties

three_d_secure_authentication_response properties

card_attributes_response properties

card_vault_response properties

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

card_from_request properties

bin_details properties

card_stored_credential properties

network_transaction_reference properties

paypal_wallet_response properties

name properties

phone-3 properties

tax_info properties

address_portable properties

Address Details properties

paypal_wallet_attributes_response properties

paypal_wallet_vault_response properties

paypal_wallet_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

cobranded_card properties

payee_base properties

money properties

paypal_wallet_stored_credential properties

bancontact properties

blik properties

blik_one_click_response properties

eps properties

giropay properties

ideal properties

mybank properties

p24 properties

sofort properties

trustly properties

apple_pay properties

phone properties

apple_pay_card_response properties

authentication_response properties

three_d_secure_authentication_response properties

card_attributes_response properties

card_vault_response properties

card_customer properties

phone_with_type properties

phone_number_without_country_code properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

card_from_request properties

bin_details properties

card_stored_credential properties

network_transaction_reference properties

address_portable properties

Address Details properties

apple_pay_attributes_response properties

vault_response properties

customer properties

phone_with_type properties

phone_number_without_country_code properties