Order Confirm Application Context
June 5, 2026 ยท View on GitHub
Customizes the payer confirmation experience.
Structure
OrderConfirmApplicationContext
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
BrandName | String | Optional | Label to present to your payer as part of the PayPal hosted web experience. Constraints: Minimum Length: 1, Maximum Length: 127 | String getBrandName() | setBrandName(String brandName) |
Locale | String | Optional | 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. Constraints: Minimum Length: 2, Maximum Length: 10, Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$ | String getLocale() | setLocale(String locale) |
ReturnUrl | String | Optional | The URL where the customer is redirected after the customer approves the payment. Constraints: Minimum Length: 10, Maximum Length: 4000 | String getReturnUrl() | setReturnUrl(String returnUrl) |
CancelUrl | String | Optional | The URL where the customer is redirected after the customer cancels the payment. Constraints: Minimum Length: 10, Maximum Length: 4000 | String getCancelUrl() | setCancelUrl(String cancelUrl) |
StoredPaymentSource | StoredPaymentSource | Optional | Provides 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. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. | StoredPaymentSource getStoredPaymentSource() | setStoredPaymentSource(StoredPaymentSource storedPaymentSource) |
Example (as JSON)
{
"brand_name": "brand_name6",
"locale": "locale0",
"return_url": "return_url8",
"cancel_url": "cancel_url0",
"stored_payment_source": {
"payment_initiator": "CUSTOMER",
"payment_type": "RECURRING",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "id6",
"date": "date2",
"network": "CONFIDIS",
"acquirer_reference_number": "acquirer_reference_number8"
}
}
}