UIComponents/com.braintreepayments.api.uicomponents.compose/PayPalButton

PayPalButton

@Composable
fun PayPalButton(style: PayPalButtonColor, payPalRequest: PayPalRequest, authorization: String, appLinkReturnUrl: Uri, deepLinkFallbackUrlScheme: String, pendingRequestRepository: PendingRequestRepository = PendingRequestRepository(LocalContext.current, "paypal"), paypalTokenizeCallback: PayPalTokenizeCallback)

A composable that displays a PayPal branded button.

Parameters

style

: A PayPalButtonColor that determines the color of the button.

payPalRequest

: A PayPalRequest that provides the parameters to tokenize a paypal account.

authorization

: An authorization string to use for tokenization.

appLinkReturnUrl

: A Uri that sends back control to the host app after PayPal flow completes.

deepLinkFallbackUrlScheme

: Fallback scheme in case appLinkReturnUrl doesn't work.

The value must be a bare URL scheme, not a full URL. It must:

  • Contain only alphanumeric characters, hyphens (-), and periods (.)

  • Not include ://

  • Not include a path, query string, or fragment (no /, ?, or #)

  • Match the scheme declared in your AndroidManifest.xml

Valid examples: "com.merchant.app.payments", "merchantapp", "merchant-app.payments".

Invalid examples: "com.merchant.app.payments://" (contains ://), "com.merchant.app.payments/callback" (contains a path), "com.merchant_app" (underscore not allowed).

paypalTokenizeCallback

: A PayPalTokenizeCallback that handles the result of the tokenization.