Verifone · Schema
applicationContext
The application context, which customizes the payer experience during the subscription approval process with PayPal
PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel
Properties
| Name | Type | Description |
|---|---|---|
| brandName | string | The label that overrides the business name in the PayPal account on the PayPal site |
| locale | string | 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, |
| shippingPreference | string | The location from which the shipping address is derived |
| userAction | string | Configures the label name to Continue or Subscribe Now for subscription consent experience |
| paymentMethod | object | |
| returnUrl | string | The URL where the customer is redirected after the customer approves the payment |
| cancelUrl | string | The URL where the customer is redirected after the customer cancels the payment |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/paypal-ecommerce-api-applicationcontext.json",
"title": "applicationContext",
"description": "The application context, which customizes the payer experience during the subscription approval process with PayPal",
"type": "object",
"properties": {
"brandName": {
"type": "string",
"description": "The label that overrides the business name in the PayPal account on the PayPal site"
},
"locale": {
"type": "string",
"description": "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"
},
"shippingPreference": {
"type": "string",
"description": "The location from which the shipping address is derived",
"enum": [
"GET_FROM_FILE",
"NO_SHIPPING",
"SET_PROVIDED_ADDRESS"
]
},
"userAction": {
"type": "string",
"description": "Configures the label name to Continue or Subscribe Now for subscription consent experience",
"enum": [
"CONTINUE",
"SUBSCRIBE_NOW"
]
},
"paymentMethod": {
"$ref": "#/components/schemas/paymentMethod"
},
"returnUrl": {
"type": "string",
"description": "The URL where the customer is redirected after the customer approves the payment"
},
"cancelUrl": {
"type": "string",
"description": "The URL where the customer is redirected after the customer cancels the payment"
}
}
}