On this page
No Headings
Customizes the payer confirmation experience.
objectbrand_namestring^[\S\s]*$Label to present to your payer as part of the PayPal hosted web experience.
localeobject^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$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.
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
return_urlstringuriThe URL where the customer is redirected after the customer approves the payment.
cancel_urlstringuriThe URL where the customer is redirected after the customer cancels the payment.
stored_payment_sourceobjectProvides additional details to process a payment using a payment_source 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.previous_transaction_reference and previous_network_transaction_reference - can be present in the request.payment_initiatorrequiredstring"CUSTOMER", "MERCHANT"The person or party who initiated or triggered the payment.
payment_typerequiredstring"ONE_TIME", "RECURRING", "UNSCHEDULED"Indicates the type of the stored payment_source payment.
usagestring"FIRST", "SUBSEQUENT", "DERIVED""DERIVED"Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
previous_network_transaction_referenceobjectReference values used by the card network to identify a transaction.
idrequiredstring^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$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 -.
datestring^[0-9]+$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". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the previous_network_transaction_reference_id is passed.
networkobject"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"The card network or brand. Applies to credit, debit, gift, and payment cards.
Name of the card network through which the transaction was routed.
acquirer_reference_numberstring^[a-zA-Z0-9]+$Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.