The payment source used to fund the payment.
cardobject<card_response>Optionalbrandenum<card_brand>Optionalavailable_networksarray<card_brand>Optionaltypeenum<card_type>Optionalauthentication_resultobject<authentication_response>Optionalliability_shiftenum<liability_shift>Optionalthree_d_secureobject<three_d_secure_authentication_response>Optionalauthentication_statusenum<pares_status>Optionalenrollment_statusenum<enrolled>Optionalattributesobject<card_attributes_response>Optionalvaultobject<card_vault_response>OptionalstatusenumOptionalcustomerobject<card_customer>Optionalidstring<merchant_partner_customer_id>Optionalemail_addressstring<email>OptionalNote: 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.
phoneobject<phone_with_type>Optionalphone_typeenum<phone_type>Optionalphone_numberobject<phone>Requiredcountry_codestring<country_calling_code>Requirednational_numberstringRequirednameobject<name>Optionallinksobject<link_description>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema>OptionaltargetSchemaobject<link_schema>Optionalfrom_requestobject<card_from_request>Optionalexpirystring<date_year_month>Optionalexpirystring<date_year_month>Optionalbin_detailsobject<bin_details>Optionalbin_country_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
stored_credentialobject<card_stored_credential>Optionalpayment_initiatorenum<payment_initiator>Requiredpayment_typeenum<stored_payment_source_payment_type>Requiredusageenum<stored_payment_source_usage_type>Optionalprevious_network_transaction_referenceobject<network_transaction_reference>OptionalidstringRequireddatestringOptionalnetworkenum<card_brand>Optionalpaypalobject<paypal_wallet_response>Optionalemail_addressstring<email>OptionalNote: 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.
account_idstring<account_id-2>Optionalaccount_statusenumOptionalnameobject<name>Optionalphone_typeenum<phone_type>Optionalphone_numberobject<phone-3>Optionalnational_numberstringRequiredbirth_datestring<date_no_time>Optionaltax_infoobject<tax_info>Optionaladdressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionalattributesobject<paypal_wallet_attributes_response>Optionalvaultobject<paypal_wallet_vault_response>OptionalstatusenumOptionalcustomerobject<paypal_wallet_customer>Optionalidstring<merchant_partner_customer_id>Optionalemail_addressstring<email>OptionalNote: 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.
phoneobject<phone_with_type>Optionalphone_typeenum<phone_type>Optionalphone_numberobject<phone>Requiredcountry_codestring<country_calling_code>Requirednational_numberstringRequirednameobject<name>Optionallinksobject<link_description>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema>OptionaltargetSchemaobject<link_schema>Optionalcobranded_cardsobject<cobranded_card>[]Optionalpayeeobject<payee_base>Optionalemail_addressstring<email>OptionalNote: 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.
merchant_idstring<account_id>Optionalamountobject<money>Optionalcurrency_codestring<currency_code>RequiredvaluestringRequiredstored_credentialobject<paypal_wallet_stored_credential>Optionalpayment_initiatorenum<payment_initiator>Requiredcharge_patternenum<charge_pattern>OptionalDeprecated| See |
|---|
| usage_pattern |
usage_patternenum<charge_pattern>Optionalusageenum<stored_payment_source_usage_type>Optionalexperience_statusenumOptionalbancontactobject<bancontact>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
bicstring<bic>Optionaliban_last_charsstring<iban_last_chars>Optionalblikobject<blik>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
emailstring<email_address>OptionalNote: 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.
one_clickobject<blik_one_click_response>Optionalepsobject<eps>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
bicstring<bic>Optionalgiropayobject<giropay>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
bicstring<bic>Optionalidealobject<ideal>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
bicstring<bic>Optionaliban_last_charsstring<iban_last_chars>Optionalmybankobject<mybank>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
bicstring<bic>Optionaliban_last_charsstring<iban_last_chars>Optionalp24object<p24>Optionalnamestring<full_name>Optionalemailstring<email_address>OptionalNote: 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.
country_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
sofortobject<sofort>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
bicstring<bic>Optionaliban_last_charsstring<iban_last_chars>Optionaltrustlyobject<trustly>Optionalnamestring<full_name>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
emailstring<email_address>OptionalNote: 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.
bicstring<bic>Optionaliban_last_charsstring<iban_last_chars>Optionalapple_payobject<apple_pay>Optionalnamestring<full_name>Optionalemail_addressstring<email_address>OptionalNote: 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.
phone_numberobject<phone>Optionalcountry_codestring<country_calling_code>Requirednational_numberstringRequiredcardobject<apple_pay_card_response>Optionalbrandenum<card_brand>Optionalavailable_networksarray<card_brand>Optionaltypeenum<card_type>Optionalauthentication_resultobject<authentication_response>Optionalliability_shiftenum<liability_shift>Optionalthree_d_secureobject<three_d_secure_authentication_response>Optionalauthentication_statusenum<pares_status>Optionalenrollment_statusenum<enrolled>Optionalattributesobject<card_attributes_response>Optionalvaultobject<card_vault_response>OptionalstatusenumOptionalcustomerobject<card_customer>Optionalidstring<merchant_partner_customer_id>Optionalemail_addressstring<email>OptionalNote: 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.
phoneobject<phone_with_type>Optionalphone_typeenum<phone_type>Optionalphone_numberobject<phone>Requiredcountry_codestring<country_calling_code>Requirednational_numberstringRequirednameobject<name>Optionallinksobject<link_description>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema>OptionaltargetSchemaobject<link_schema>Optionalfrom_requestobject<card_from_request>Optionalexpirystring<date_year_month>Optionalexpirystring<date_year_month>Optionalbin_detailsobject<bin_details>Optionalbin_country_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
stored_credentialobject<card_stored_credential>Optionalpayment_initiatorenum<payment_initiator>Requiredpayment_typeenum<stored_payment_source_payment_type>Requiredusageenum<stored_payment_source_usage_type>Optionalprevious_network_transaction_referenceobject<network_transaction_reference>OptionalidstringRequireddatestringOptionalnetworkenum<card_brand>Optionalbilling_addressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionalcountry_codestring<country_code-2>OptionalNote: The country code for Great Britain isGBand notUKas 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.
attributesobject<apple_pay_attributes_response>Optionalvaultobject<vault_response>OptionalstatusenumOptionalcustomerobject<customer>Optionalidstring<merchant_partner_customer_id>Optionalemail_addressstring<email>OptionalNote: 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.
phoneobject<phone_with_type>Optionalphone_typeenum<phone_type>Optionalphone_numberobject<phone>Requiredcountry_codestring<country_calling_code>Requirednational_numberstringRequirednameobject<name>Optionallinksobject<link_description>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema>OptionaltargetSchemaobject<link_schema>Optionalstored_credentialobject<card_stored_credential>Optionalpayment_initiatorenum<payment_initiator>Requiredpayment_typeenum<stored_payment_source_payment_type>Requiredusageenum<stored_payment_source_usage_type>Optionalprevious_network_transaction_referenceobject<network_transaction_reference>OptionalidstringRequireddatestringOptionalnetworkenum<card_brand>Optionalgoogle_payobject<google_pay>Optionalnamestring<full_name>Optionalemail_addressstring<email_address>OptionalNote: 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.
phone_numberobject<phone_with_national_required_and_country_code>Optionalcountry_codestring<country_calling_code>Optionalnational_numberstringRequiredcardobject<google_pay_card_response>Optionaltypeenum<card_type>Optionalbrandenum<card_brand>Optionalbilling_addressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionalauthentication_resultobject<authentication_response>Optionalliability_shiftenum<liability_shift>Optionalthree_d_secureobject<three_d_secure_authentication_response>Optionalauthentication_statusenum<pares_status>Optionalenrollment_statusenum<enrolled>Optionalvenmoobject<venmo_wallet_response>Optionalemail_addressstring<email>OptionalNote: 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.
account_idstring<account_id-2>Optionalnameobject<name>Optionalphone_numberobject<phone-3>Optionalnational_numberstringRequiredaddressobject<address_portable>Optionaladmin_area_4stringOptionaladmin_area_3stringOptionaladmin_area_1stringOptionalcountry_codestring<country_code>RequiredNote: The country code for Great Britain isGBand notUKas 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.
address_detailsobject<Address Details>Optionalreturn_flowenumOptionalattributesobject<venmo_wallet_attributes_response>Optionalvaultobject<venmo_vault_response>OptionalstatusenumOptionalcustomerobject<venmo_wallet_customer>Optionalidstring<merchant_partner_customer_id>Optionalemail_addressstring<email>OptionalNote: 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.
phoneobject<phone_with_type>Optionalphone_typeenum<phone_type>Optionalphone_numberobject<phone>Requiredcountry_codestring<country_calling_code>Requirednational_numberstringRequirednameobject<name>Optionallinksobject<link_description>[]OptionalhrefstringRequiredrelstringRequiredmethodenumOptionalschemaobject<link_schema>OptionaltargetSchemaobject<link_schema>Optionalcryptoobject<crypto>Optionalcountry_codestring<country_code>OptionalNote: The country code for Great Britain isGBand notUKas 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.
nameobject<crypto_account_holder_name>Optionalexperience_contextobject<experience_context_base>Optionallocalestring<language>Optionalshipping_preferenceenumOptional