web / usePayPal

Function: usePayPal()

usePayPal(): object

Defined in: apps/web/app/composables/usePayPal/usePayPal.ts:19

Returns

activatedAPMs

activatedAPMs: Ref<string, string> = ''

captureOrder()

captureOrder: (PayPalOrderId) => Promise<any>

Parameters

PayPalOrderId

string

string

Returns

Promise<any>

CaptureOrder

Description

Function for (re-)capturing a PayPal order.

Example

captureOrder({
   paypalOrderId: '1'
});

config

config: Ref<PayPalSettings | null, PayPalSettings | null>

createPlentyOrder()

createPlentyOrder: () => Promise<Order & object | null>

Returns

Promise<Order & object | null>

Order | null

Description

Function for create a Plenty order.

Example

createPlentyOrder();

createPlentyPaymentFromPayPalOrder()

createPlentyPaymentFromPayPalOrder: (PayPalOrderId, plentyOrderId) => Promise<any>

Parameters

PayPalOrderId

string

string

plentyOrderId

number

number

Returns

Promise<any>

CaptureOrder

Description

Function for (re-)capturing a PayPal order.

Example

captureOrder({
   paypalOrderId: '1'
});

createTransaction()

createTransaction: (params) => Promise<PayPalCreateOrder | null>

Parameters

params

PayPalCreateOrderRequest

Returns

Promise<PayPalCreateOrder | null>

CreateTransaction

Description

Function for creating a PayPal transaction.

Example

createTransaction('paypal', true);

fraudId

fraudId: Ref<string | null, string | null>

getCurrentScript()

getCurrentScript: () => PayPalNamespace | null

Returns

PayPalNamespace | null

getFraudId()

getFraudId: () => Promise<string | null>

Returns

Promise<string | null>

Description

Function to get the fraud id.

Example

getFraudId();

getOrder()

getOrder: (paypalOrderId) => Promise<any>

Parameters

paypalOrderId

string

Returns

Promise<any>

Description

Function to get order details from PayPal.

Example

getOrder('paypal_transaction_id');

getScript()

getScript: (currency, commit) => Promise<PayPalNamespace | null>

Parameters

currency

string

commit

boolean = false

Returns

Promise<PayPalNamespace | null>

Description

Function to get the PayPal SDK script.

isAvailable()

isAvailable: (key) => ComputedRef<boolean>

Parameters

key

PayPalVisibilityLocations

Returns

ComputedRef<boolean>

isReady

isReady: Ref<boolean, boolean> = false

loadConfig()

loadConfig: () => Promise<boolean>

Returns

Promise<boolean>

Description

Function to get the PayPal config.

Example

loadConfig();

loadedConfig

loadedConfig: Ref<boolean, boolean> = false

loading

loading: Ref<boolean, boolean> = false

loadingScripts

loadingScripts: Ref<PayPalLoadScript, PayPalLoadScript>

order

order: Ref<PayPalCreateOrder | null, PayPalCreateOrder | null>

payLaterVisibility

payLaterVisibility: object

payLaterVisibility.getVisibility()

getVisibility: (key) => boolean

Parameters

key

PayPalVisibilityLocations | undefined

Returns

boolean

payLaterVisibility.setState()

setState: (settings) => void

Parameters

settings

PayPalButtonSettings | null

Returns

void

payLaterVisibility.showOnCartPage

showOnCartPage: Ref<boolean, boolean> = false

payLaterVisibility.showOnCheckoutPage

showOnCheckoutPage: Ref<boolean, boolean> = false

payLaterVisibility.showOnGuestLoginPage

showOnGuestLoginPage: Ref<boolean, boolean> = false

payLaterVisibility.showOnItemPage

showOnItemPage: Ref<boolean, boolean> = false

payLaterVisibility.showOnQuickCheckout

showOnQuickCheckout: Ref<boolean, boolean> = false

paypalScript

paypalScript: Ref<PayPalScript | null, PayPalScript | null>

payPalVisibility

payPalVisibility: object

payPalVisibility.getVisibility()

getVisibility: (key) => boolean

Parameters

key

PayPalVisibilityLocations | undefined

Returns

boolean

payPalVisibility.setState()

setState: (settings) => void

Parameters

settings

PayPalButtonSettings | null

Returns

void

payPalVisibility.showOnCartPage

showOnCartPage: Ref<boolean, boolean> = false

payPalVisibility.showOnCheckoutPage

showOnCheckoutPage: Ref<boolean, boolean> = false

payPalVisibility.showOnGuestLoginPage

showOnGuestLoginPage: Ref<boolean, boolean> = false

payPalVisibility.showOnItemPage

showOnItemPage: Ref<boolean, boolean> = false

payPalVisibility.showOnQuickCheckout

showOnQuickCheckout: Ref<boolean, boolean> = false

setAddressesFromPayPal()

setAddressesFromPayPal: (paypalOrderId) => Promise<any>

Parameters

paypalOrderId

string

Returns

Promise<any>

Description

Function to get order details from PayPal.

Example

getOrder('paypal_transaction_id');

state

state: Ref<{ activatedAPMs: string; config: PayPalSettings | null; fraudId: string | null; isReady: boolean; loadedConfig: boolean; loading: boolean; loadingScripts: PayPalLoadScript; order: PayPalCreateOrder | null; paypalScript: PayPalScript | null; }, { activatedAPMs: string; config: PayPalSettings | null; fraudId: string | null; isReady: boolean; loadedConfig: boolean; loading: boolean; loadingScripts: PayPalLoadScript; order: PayPalCreateOrder | null; paypalScript: PayPalScript | null; }>

updateAvailableAPMs()

updateAvailableAPMs: (script, currency) => Promise<void>

Parameters

script

PayPalNamespace

currency

string

Returns

Promise<void>

Description

Composable for managing PayPal interaction.

Example

const {
loading, paypalScript, order, config, loadScript, loadConfig, createTransaction, approveOrder, executeOrder,
createCreditCardTransaction, captureOrder } = usePayPal();