Below, is a summary of all classes and their component's visiblity. Whenever a visibility is set and used at the right level, a green star is presented. Whenever it is set to a level, but could be updated to another, red and orange stars are mentioned. .
| Name | Value | None (public) | Public | Protected | Private | Constant | ||
| class AbstractRequest | ||||||||
| API_VERSION | '119.0' | |||||||
| $liveEndpoint | ||||||||
| $testEndpoint | ||||||||
| $negativeAmountAllowed | ||||||||
| class AbstractRestRequest | ||||||||
| API_VERSION | 'v1' | |||||||
| $testEndpoint | ||||||||
| $liveEndpoint | ||||||||
| $payerId | ||||||||
| $referrerCode | ||||||||
| $negativeAmountAllowed | ||||||||
| class ExpressAuthorizeRequest | ||||||||
| DEFAULT_CALLBACK_TIMEOUT | 5 | |||||||
| class RestGateway | ||||||||
| BILLING_PLAN_FREQUENCY_DAY | 'DAY' | |||||||
| BILLING_PLAN_FREQUENCY_MONTH | 'MONTH' | |||||||
| BILLING_PLAN_FREQUENCY_WEEK | 'WEEK' | |||||||
| BILLING_PLAN_FREQUENCY_YEAR | 'YEAR' | |||||||
| BILLING_PLAN_STATE_ACTIVE | 'ACTIVE' | |||||||
| BILLING_PLAN_STATE_CREATED | 'CREATED' | |||||||
| BILLING_PLAN_STATE_DELETED | 'DELETED' | |||||||
| BILLING_PLAN_STATE_INACTIVE | 'INACTIVE' | |||||||
| BILLING_PLAN_TYPE_FIXED | 'FIXED' | |||||||
| BILLING_PLAN_TYPE_INFINITE | 'INFINITE' | |||||||
| PAYMENT_REGULAR | 'REGULAR' | |||||||
| PAYMENT_TRIAL | 'TRIAL' | |||||||
| class RestPurchaseRequest | ||||||||
| SHIPPING_PREFERENCE_GET_FROM_FILE | 'GET_FROM_FILE' | |||||||
| SHIPPING_PREFERENCE_NO_SHIPPING | 'NO_SHIPPING' | |||||||
| SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS | 'SET_PROVIDED_ADDRESS' | |||||||
| class BillingAgreement | ||||||||
| $types | ||||||||
| $type | ||||||||
| $description | ||||||||
| $paymentType | ||||||||
| $customAnnotation | ||||||||
| class ShippingOption | ||||||||
| $name | ||||||||
| $amount | ||||||||
| $isDefault | ||||||||
| $label | ||||||||
| class RestResponse | ||||||||
| $statusCode | ||||||||
| class ExpressAuthorizeResponse | ||||||||
| $liveCheckoutEndpoint | ||||||||
| $testCheckoutEndpoint | ||||||||
| class ExpressInContextAuthorizeResponse | ||||||||
| $liveCheckoutEndpoint | ||||||||
| $testCheckoutEndpoint | ||||||||
| class | ||||||||
| add | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| getDefaultParameters | ||||||||
| class | ||||||||
| getUsername | ||||||||
| class | ||||||||
| setUsername | ||||||||
| class | ||||||||
| getPassword | ||||||||
| class | ||||||||
| setPassword | ||||||||
| class | ||||||||
| getSignature | ||||||||
| class | ||||||||
| setSignature | ||||||||
| class | ||||||||
| authorize | ||||||||
| class | ||||||||
| purchase | ||||||||
| class | ||||||||
| capture | ||||||||
| class | ||||||||
| refund | ||||||||
| class | ||||||||
| fetchTransaction | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| getDefaultParameters | ||||||||
| class | ||||||||
| getClientId | ||||||||
| class | ||||||||
| setClientId | ||||||||
| class | ||||||||
| getSecret | ||||||||
| class | ||||||||
| setSecret | ||||||||
| class | ||||||||
| getToken | ||||||||
| class | ||||||||
| createToken | ||||||||
| class | ||||||||
| setToken | ||||||||
| class | ||||||||
| getTokenExpires | ||||||||
| class | ||||||||
| setTokenExpires | ||||||||
| class | ||||||||
| hasToken | ||||||||
| class | ||||||||
| createRequest | ||||||||
| class | ||||||||
| purchase | ||||||||
| class | ||||||||
| fetchPurchase | ||||||||
| class | ||||||||
| listPurchase | ||||||||
| class | ||||||||
| completePurchase | ||||||||
| class | ||||||||
| createWebhook | ||||||||
| class | ||||||||
| authorize | ||||||||
| class | ||||||||
| void | ||||||||
| class | ||||||||
| capture | ||||||||
| class | ||||||||
| refundCapture | ||||||||
| class | ||||||||
| fetchTransaction | ||||||||
| class | ||||||||
| refund | ||||||||
| class | ||||||||
| createCard | ||||||||
| class | ||||||||
| deleteCard | ||||||||
| class | ||||||||
| createPlan | ||||||||
| class | ||||||||
| updatePlan | ||||||||
| class | ||||||||
| listPlan | ||||||||
| class | ||||||||
| createSubscription | ||||||||
| class | ||||||||
| completeSubscription | ||||||||
| class | ||||||||
| cancelSubscription | ||||||||
| class | ||||||||
| suspendSubscription | ||||||||
| class | ||||||||
| reactivateSubscription | ||||||||
| class | ||||||||
| searchTransaction | ||||||||
| class | ||||||||
| listWebhooks | ||||||||
| class | ||||||||
| verifyWebhookSignature | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| getDefaultParameters | ||||||||
| class | ||||||||
| getSolutionType | ||||||||
| class | ||||||||
| setSolutionType | ||||||||
| class | ||||||||
| getLandingPage | ||||||||
| class | ||||||||
| setLandingPage | ||||||||
| class | ||||||||
| getBrandName | ||||||||
| class | ||||||||
| setBrandName | ||||||||
| class | ||||||||
| getHeaderImageUrl | ||||||||
| class | ||||||||
| getLogoImageUrl | ||||||||
| class | ||||||||
| getBorderColor | ||||||||
| class | ||||||||
| setHeaderImageUrl | ||||||||
| class | ||||||||
| setLogoImageUrl | ||||||||
| class | ||||||||
| setBorderColor | ||||||||
| class | ||||||||
| setSellerPaypalAccountId | ||||||||
| class | ||||||||
| getSellerPaypalAccountId | ||||||||
| class | ||||||||
| authorize | ||||||||
| class | ||||||||
| completeAuthorize | ||||||||
| class | ||||||||
| purchase | ||||||||
| class | ||||||||
| completePurchase | ||||||||
| class | ||||||||
| void | ||||||||
| class | ||||||||
| fetchCheckout | ||||||||
| class | ||||||||
| transactionSearch | ||||||||
| class | ||||||||
| order | ||||||||
| class | ||||||||
| completeOrder | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| authorize | ||||||||
| class | ||||||||
| order | ||||||||
| class | ||||||||
| getCode | ||||||||
| class | ||||||||
| setCode | ||||||||
| class | ||||||||
| __construct | ||||||||
| class | ||||||||
| getType | ||||||||
| class | ||||||||
| getDescription | ||||||||
| class | ||||||||
| hasPaymentType | ||||||||
| class | ||||||||
| getPaymentType | ||||||||
| class | ||||||||
| hasCustomAnnotation | ||||||||
| class | ||||||||
| getCustomAnnotation | ||||||||
| class | ||||||||
| __construct | ||||||||
| class | ||||||||
| hasLabel | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| getAmount | ||||||||
| class | ||||||||
| isDefault | ||||||||
| class | ||||||||
| getLabel | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getPayerID | ||||||||
| class | ||||||||
| setPayerID | ||||||||
| class | ||||||||
| getAgreementId | ||||||||
| class | ||||||||
| setAgreementId | ||||||||
| class | ||||||||
| getStartDate | ||||||||
| class | ||||||||
| setStartDate | ||||||||
| class | ||||||||
| getEndDate | ||||||||
| class | ||||||||
| setEndDate | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| isSuccessful | ||||||||
| class | ||||||||
| isRedirect | ||||||||
| class | ||||||||
| getTransactionReference | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| __construct | ||||||||
| class | ||||||||
| isSuccessful | ||||||||
| class | ||||||||
| getTransactionReference | ||||||||
| class | ||||||||
| getMessage | ||||||||
| class | ||||||||
| getCode | ||||||||
| class | ||||||||
| getCardReference | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getExperienceProfileId | ||||||||
| class | ||||||||
| setExperienceProfileId | ||||||||
| class | ||||||||
| getDescription | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| isSuccessful | ||||||||
| class | ||||||||
| isRedirect | ||||||||
| class | ||||||||
| getRedirectUrl | ||||||||
| class | ||||||||
| getTransactionReference | ||||||||
| class | ||||||||
| getRedirectMethod | ||||||||
| class | ||||||||
| getRedirectData | ||||||||
| class | ||||||||
| getRedirectQueryParameters | ||||||||
| class | ||||||||
| getCheckoutEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getState | ||||||||
| class | ||||||||
| setState | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| setCallback | ||||||||
| class | ||||||||
| getCallback | ||||||||
| class | ||||||||
| setCallbackTimeout | ||||||||
| class | ||||||||
| getCallbackTimeout | ||||||||
| class | ||||||||
| setShippingOptions | ||||||||
| class | ||||||||
| getShippingOptions | ||||||||
| class | ||||||||
| setBillingAgreement | ||||||||
| class | ||||||||
| getBillingAgreement | ||||||||
| class | ||||||||
| validateCallback | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| sendData | ||||||||
| class | ||||||||
| __construct | ||||||||
| class | ||||||||
| isPending | ||||||||
| class | ||||||||
| isSuccessful | ||||||||
| class | ||||||||
| getTransactionReference | ||||||||
| class | ||||||||
| getMessage | ||||||||
| class | ||||||||
| __construct | ||||||||
| class | ||||||||
| getPayments | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getShippingPreference | ||||||||
| class | ||||||||
| setShippingPreference | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getRedirectQueryParameters | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEventTypes | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getUrl | ||||||||
| class | ||||||||
| setEventTypes | ||||||||
| class | ||||||||
| setUrl | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| isSuccessful | ||||||||
| class | ||||||||
| isRedirect | ||||||||
| class | ||||||||
| getRedirectUrl | ||||||||
| class | ||||||||
| getCompleteUrl | ||||||||
| class | ||||||||
| getTransactionReference | ||||||||
| class | ||||||||
| getRedirectMethod | ||||||||
| class | ||||||||
| getRedirectData | ||||||||
| class | ||||||||
| isSuccessful | ||||||||
| class | ||||||||
| getVerificationStatus | ||||||||
| class | ||||||||
| getAuthAlgo | ||||||||
| class | ||||||||
| getCertUrl | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getTransmissionId | ||||||||
| class | ||||||||
| getTransmissionSig | ||||||||
| class | ||||||||
| getTransmissionTime | ||||||||
| class | ||||||||
| getWebhookEvent | ||||||||
| class | ||||||||
| getWebhookId | ||||||||
| class | ||||||||
| setAuthAlgo | ||||||||
| class | ||||||||
| setCertUrl | ||||||||
| class | ||||||||
| setTransmissionId | ||||||||
| class | ||||||||
| setTransmissionSig | ||||||||
| class | ||||||||
| setTransmissionTime | ||||||||
| class | ||||||||
| setWebhookEvent | ||||||||
| class | ||||||||
| setWebhookId | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getCount | ||||||||
| class | ||||||||
| setCount | ||||||||
| class | ||||||||
| getStartId | ||||||||
| class | ||||||||
| setStartId | ||||||||
| class | ||||||||
| getStartIndex | ||||||||
| class | ||||||||
| setStartIndex | ||||||||
| class | ||||||||
| getStartTime | ||||||||
| class | ||||||||
| setStartTime | ||||||||
| class | ||||||||
| getEndTime | ||||||||
| class | ||||||||
| setEndTime | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getReferrerCode | ||||||||
| class | ||||||||
| setReferrerCode | ||||||||
| class | ||||||||
| getClientId | ||||||||
| class | ||||||||
| setClientId | ||||||||
| class | ||||||||
| getSecret | ||||||||
| class | ||||||||
| setSecret | ||||||||
| class | ||||||||
| getToken | ||||||||
| class | ||||||||
| setToken | ||||||||
| class | ||||||||
| getPayerId | ||||||||
| class | ||||||||
| setPayerId | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| sendData | ||||||||
| class | ||||||||
| toJSON | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getStartDate | ||||||||
| class | ||||||||
| setStartDate | ||||||||
| class | ||||||||
| getEndDate | ||||||||
| class | ||||||||
| setEndDate | ||||||||
| class | ||||||||
| getSalutation | ||||||||
| class | ||||||||
| setSalutation | ||||||||
| class | ||||||||
| getFirstName | ||||||||
| class | ||||||||
| setFirstName | ||||||||
| class | ||||||||
| getMiddleName | ||||||||
| class | ||||||||
| setMiddleName | ||||||||
| class | ||||||||
| getLastName | ||||||||
| class | ||||||||
| setLastName | ||||||||
| class | ||||||||
| getSuffix | ||||||||
| class | ||||||||
| setSuffix | ||||||||
| class | ||||||||
| getEmail | ||||||||
| class | ||||||||
| setEmail | ||||||||
| class | ||||||||
| getReceiver | ||||||||
| class | ||||||||
| setReceiver | ||||||||
| class | ||||||||
| getReceiptId | ||||||||
| class | ||||||||
| setReceiptId | ||||||||
| class | ||||||||
| getInvoiceNumber | ||||||||
| class | ||||||||
| setInvoiceNumber | ||||||||
| class | ||||||||
| getAuctionItemNumber | ||||||||
| class | ||||||||
| setAuctionItemNumber | ||||||||
| class | ||||||||
| getTransactionClass | ||||||||
| class | ||||||||
| setTransactionClass | ||||||||
| class | ||||||||
| getStatus | ||||||||
| class | ||||||||
| setStatus | ||||||||
| class | ||||||||
| getProfileId | ||||||||
| class | ||||||||
| setProfileId | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| setName | ||||||||
| class | ||||||||
| getPlanId | ||||||||
| class | ||||||||
| setPlanId | ||||||||
| class | ||||||||
| getStartDate | ||||||||
| class | ||||||||
| setStartDate | ||||||||
| class | ||||||||
| getAgreementDetails | ||||||||
| class | ||||||||
| setAgreementDetails | ||||||||
| class | ||||||||
| getPayerDetails | ||||||||
| class | ||||||||
| setPayerDetails | ||||||||
| class | ||||||||
| getShippingAddress | ||||||||
| class | ||||||||
| setShippingAddress | ||||||||
| class | ||||||||
| getMerchantPreferences | ||||||||
| class | ||||||||
| setMerchantPreferences | ||||||||
| class | ||||||||
| getChargeModel | ||||||||
| class | ||||||||
| setChargeModel | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| getPage | ||||||||
| class | ||||||||
| setPage | ||||||||
| class | ||||||||
| getStatus | ||||||||
| class | ||||||||
| setStatus | ||||||||
| class | ||||||||
| getPageSize | ||||||||
| class | ||||||||
| setPageSize | ||||||||
| class | ||||||||
| getTotalRequired | ||||||||
| class | ||||||||
| setTotalRequired | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getHttpMethod | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getName | ||||||||
| class | ||||||||
| setName | ||||||||
| class | ||||||||
| getType | ||||||||
| class | ||||||||
| setType | ||||||||
| class | ||||||||
| getPaymentDefinitions | ||||||||
| class | ||||||||
| setPaymentDefinitions | ||||||||
| class | ||||||||
| getMerchantPreferences | ||||||||
| class | ||||||||
| setMerchantPreferences | ||||||||
| class | ||||||||
| getData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| getUsername | ||||||||
| class | ||||||||
| setUsername | ||||||||
| class | ||||||||
| getPassword | ||||||||
| class | ||||||||
| setPassword | ||||||||
| class | ||||||||
| getSignature | ||||||||
| class | ||||||||
| setSignature | ||||||||
| class | ||||||||
| getSubject | ||||||||
| class | ||||||||
| setSubject | ||||||||
| class | ||||||||
| getSolutionType | ||||||||
| class | ||||||||
| setSolutionType | ||||||||
| class | ||||||||
| getLandingPage | ||||||||
| class | ||||||||
| setLandingPage | ||||||||
| class | ||||||||
| getHeaderImageUrl | ||||||||
| class | ||||||||
| setHeaderImageUrl | ||||||||
| class | ||||||||
| getLogoImageUrl | ||||||||
| class | ||||||||
| setLogoImageUrl | ||||||||
| class | ||||||||
| getBorderColor | ||||||||
| class | ||||||||
| setBorderColor | ||||||||
| class | ||||||||
| getBrandName | ||||||||
| class | ||||||||
| setBrandName | ||||||||
| class | ||||||||
| getNoShipping | ||||||||
| class | ||||||||
| setNoShipping | ||||||||
| class | ||||||||
| getAllowNote | ||||||||
| class | ||||||||
| setAllowNote | ||||||||
| class | ||||||||
| getAddressOverride | ||||||||
| class | ||||||||
| setAddressOverride | ||||||||
| class | ||||||||
| getMaxAmount | ||||||||
| class | ||||||||
| setMaxAmount | ||||||||
| class | ||||||||
| getTaxAmount | ||||||||
| class | ||||||||
| setTaxAmount | ||||||||
| class | ||||||||
| getShippingAmount | ||||||||
| class | ||||||||
| setShippingAmount | ||||||||
| class | ||||||||
| getHandlingAmount | ||||||||
| class | ||||||||
| setHandlingAmount | ||||||||
| class | ||||||||
| getShippingDiscount | ||||||||
| class | ||||||||
| setShippingDiscount | ||||||||
| class | ||||||||
| getInsuranceAmount | ||||||||
| class | ||||||||
| setInsuranceAmount | ||||||||
| class | ||||||||
| getLocaleCode | ||||||||
| class | ||||||||
| setLocaleCode | ||||||||
| class | ||||||||
| setCustomerServiceNumber | ||||||||
| class | ||||||||
| getCustomerServiceNumber | ||||||||
| class | ||||||||
| setSellerPaypalAccountId | ||||||||
| class | ||||||||
| getSellerPaypalAccountId | ||||||||
| class | ||||||||
| setButtonSource | ||||||||
| class | ||||||||
| getButtonSource | ||||||||
| class | ||||||||
| getBaseData | ||||||||
| class | ||||||||
| getItemData | ||||||||
| class | ||||||||
| sendData | ||||||||
| class | ||||||||
| getEndpoint | ||||||||
| class | ||||||||
| createResponse | ||||||||
| class | ||||||||
| setItems | ||||||||
| class | ||||||||
| getData | ||||||||