PlentyONE Shop Docs

Appearance

web / usePayPal

Function: usePayPal() ​

usePayPal(): object

Defined in: apps/web/composables/usePayPal/usePayPal.ts:22

Returns ​

object

activatedAPMs ​

activatedAPMs: Ref<boolean, boolean> = false

captureOrder() ​

captureOrder: (PayPalOrderId) => Promise<any>

Parameters ​

PayPalOrderId ​

string

string

Returns ​

Promise<any>

CaptureOrder

Description ​

Function for (re-)capturing a PayPal order.

Example ​

ts
captureOrder({
   paypalOrderId: '1'
});

config ​

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

createPlentyOrder() ​

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

Returns ​

Promise<null | Order>

Order | null

Description ​

Function for create a Plenty order.

Example ​

ts
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 ​

ts
captureOrder({
   paypalOrderId: '1'
});

createTransaction() ​

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

Parameters ​

params ​

PayPalCreateOrderRequest

Returns ​

Promise<null | PayPalCreateOrder>

CreateTransaction

Description ​

Function for creating a PayPal transaction.

Example ​

ts
createTransaction('paypal', true);

fraudId ​

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

getFraudId() ​

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

Returns ​

Promise<null | string>

Description ​

Function to get the fraud id.

Example ​

ts
getFraudId();

getOrder() ​

getOrder: (paypalOrderId) => Promise<any>

Parameters ​

paypalOrderId ​

string

Returns ​

Promise<any>

Description ​

Function to get order details from PayPal.

Example ​

ts
getOrder('paypal_transaction_id');

getScript() ​

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

Parameters ​

currency ​

string

commit ​

boolean = false

Returns ​

Promise<null | PayPalNamespace>

Description ​

Function to get the PayPal SDK script.

isAvailable ​

isAvailable: Ref<boolean, boolean> = false

isReady ​

isReady: Ref<boolean, boolean> = false

loadConfig() ​

loadConfig: () => Promise<boolean>

Returns ​

Promise<boolean>

Description ​

Function to get the PayPal config.

Example ​

ts
loadConfig();

loadedConfig ​

loadedConfig: Ref<boolean, boolean> = false

loading ​

loading: Ref<boolean, boolean> = false

loadingScripts ​

loadingScripts: Ref<PayPalLoadScript, PayPalLoadScript>

order ​

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

paypalScript ​

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

setAddressesFromPayPal() ​

setAddressesFromPayPal: (paypalOrderId) => Promise<any>

Parameters ​

paypalOrderId ​

string

Returns ​

Promise<any>

Description ​

Function to get order details from PayPal.

Example ​

ts
getOrder('paypal_transaction_id');

state ​

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

updateAvailableAPMs() ​

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

Parameters ​

currency ​

string

commit ​

boolean = true

Returns ​

Promise<void>

Description ​

Composable for managing PayPal interaction.

Example ​

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