PHP Class PayPal\Service\PayPalAPIInterfaceServiceService

Inheritance: extends PayPal\Core\PPBaseService
Show file Open project: paypal/merchant-sdk-php Class Usage Examples

Protected Properties

Property Type Description
$SDK_NAME SDK Name
$SDK_VERSION SDK Version

Public Methods

Method Description
AddressVerify ( AddressVerifyReq $addressVerifyReq, mixed $apiCredential = null ) : AddressVerifyResponseType Service Call: AddressVerify
BillAgreementUpdate ( BillAgreementUpdateReq $billAgreementUpdateReq, mixed $apiCredential = null ) : BAUpdateResponseType Service Call: BillAgreementUpdate
BillOutstandingAmount ( BillOutstandingAmountReq $billOutstandingAmountReq, mixed $apiCredential = null ) : BillOutstandingAmountResponseType Service Call: BillOutstandingAmount
BillUser ( BillUserReq $billUserReq, mixed $apiCredential = null ) : BillUserResponseType Service Call: BillUser
CancelRecoup ( CancelRecoupReq $cancelRecoupReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\CancelRecoupResponseType Service Call: CancelRecoup
CompleteRecoup ( CompleteRecoupReq $completeRecoupReq, mixed $apiCredential = null ) : CompleteRecoupResponseType Service Call: CompleteRecoup
CreateBillingAgreement ( CreateBillingAgreementReq $createBillingAgreementReq, mixed $apiCredential = null ) : CreateBillingAgreementResponseType Service Call: CreateBillingAgreement
CreateMobilePayment ( CreateMobilePaymentReq $createMobilePaymentReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\CreateMobilePaymentResponseType Service Call: CreateMobilePayment
CreateRecurringPaymentsProfile ( CreateRecurringPaymentsProfileReq $createRecurringPaymentsProfileReq, mixed $apiCredential = null ) : CreateRecurringPaymentsProfileResponseType Service Call: CreateRecurringPaymentsProfile
DoAuthorization ( DoAuthorizationReq $doAuthorizationReq, mixed $apiCredential = null ) : DoAuthorizationResponseType Service Call: DoAuthorization
DoCancel ( DoCancelReq $doCancelReq, mixed $apiCredential = null ) : DoCancelResponseType Service Call: DoCancel
DoCapture ( DoCaptureReq $doCaptureReq, mixed $apiCredential = null ) : DoCaptureResponseType Service Call: DoCapture
DoDirectPayment ( DoDirectPaymentReq $doDirectPaymentReq, mixed $apiCredential = null ) : DoDirectPaymentResponseType Service Call: DoDirectPayment
DoExpressCheckoutPayment ( DoExpressCheckoutPaymentReq $doExpressCheckoutPaymentReq, mixed $apiCredential = null ) : DoExpressCheckoutPaymentResponseType Service Call: DoExpressCheckoutPayment
DoMobileCheckoutPayment ( DoMobileCheckoutPaymentReq $doMobileCheckoutPaymentReq, mixed $apiCredential = null ) : DoMobileCheckoutPaymentResponseType Service Call: DoMobileCheckoutPayment
DoNonReferencedCredit ( DoNonReferencedCreditReq $doNonReferencedCreditReq, mixed $apiCredential = null ) : DoNonReferencedCreditResponseType Service Call: DoNonReferencedCredit
DoReauthorization ( DoReauthorizationReq $doReauthorizationReq, mixed $apiCredential = null ) : DoReauthorizationResponseType Service Call: DoReauthorization
DoReferenceTransaction ( DoReferenceTransactionReq $doReferenceTransactionReq, mixed $apiCredential = null ) : DoReferenceTransactionResponseType Service Call: DoReferenceTransaction
DoUATPAuthorization ( DoUATPAuthorizationReq $doUATPAuthorizationReq, mixed $apiCredential = null ) : DoUATPAuthorizationResponseType Service Call: DoUATPAuthorization
DoUATPExpressCheckoutPayment ( DoUATPExpressCheckoutPaymentReq $doUATPExpressCheckoutPaymentReq, mixed $apiCredential = null ) : DoUATPExpressCheckoutPaymentResponseType Service Call: DoUATPExpressCheckoutPayment
DoVoid ( DoVoidReq $doVoidReq, mixed $apiCredential = null ) : DoVoidResponseType Service Call: DoVoid
EnterBoarding ( EnterBoardingReq $enterBoardingReq, mixed $apiCredential = null ) : EnterBoardingResponseType Service Call: EnterBoarding
ExecuteCheckoutOperations ( ExecuteCheckoutOperationsReq $executeCheckoutOperationsReq, mixed $apiCredential = null ) : ExecuteCheckoutOperationsResponseType Service Call: ExecuteCheckoutOperations
ExternalRememberMeOptOut ( ExternalRememberMeOptOutReq $externalRememberMeOptOutReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\ExternalRememberMeOptOutResponseType Service Call: ExternalRememberMeOptOut
GetAccessPermissionDetails ( GetAccessPermissionDetailsReq $getAccessPermissionDetailsReq, mixed $apiCredential = null ) : GetAccessPermissionDetailsResponseType Service Call: GetAccessPermissionDetails
GetAuthDetails ( GetAuthDetailsReq $getAuthDetailsReq, mixed $apiCredential = null ) : GetAuthDetailsResponseType Service Call: GetAuthDetails
GetBalance ( GetBalanceReq $getBalanceReq, mixed $apiCredential = null ) : GetBalanceResponseType Service Call: GetBalance
GetBillingAgreementCustomerDetails ( GetBillingAgreementCustomerDetailsReq $getBillingAgreementCustomerDetailsReq, mixed $apiCredential = null ) : GetBillingAgreementCustomerDetailsResponseType Service Call: GetBillingAgreementCustomerDetails
GetBoardingDetails ( GetBoardingDetailsReq $getBoardingDetailsReq, mixed $apiCredential = null ) : GetBoardingDetailsResponseType Service Call: GetBoardingDetails
GetExpressCheckoutDetails ( GetExpressCheckoutDetailsReq $getExpressCheckoutDetailsReq, mixed $apiCredential = null ) : GetExpressCheckoutDetailsResponseType Service Call: GetExpressCheckoutDetails
GetIncentiveEvaluation ( GetIncentiveEvaluationReq $getIncentiveEvaluationReq, mixed $apiCredential = null ) : GetIncentiveEvaluationResponseType Service Call: GetIncentiveEvaluation
GetMobileStatus ( GetMobileStatusReq $getMobileStatusReq, mixed $apiCredential = null ) : GetMobileStatusResponseType Service Call: GetMobileStatus
GetPalDetails ( GetPalDetailsReq $getPalDetailsReq, mixed $apiCredential = null ) : GetPalDetailsResponseType Service Call: GetPalDetails
GetRecurringPaymentsProfileDetails ( GetRecurringPaymentsProfileDetailsReq $getRecurringPaymentsProfileDetailsReq, mixed $apiCredential = null ) : GetRecurringPaymentsProfileDetailsResponseType Service Call: GetRecurringPaymentsProfileDetails
GetTransactionDetails ( GetTransactionDetailsReq $getTransactionDetailsReq, mixed $apiCredential = null ) : GetTransactionDetailsResponseType Service Call: GetTransactionDetails
InitiateRecoup ( InitiateRecoupReq $initiateRecoupReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\InitiateRecoupResponseType Service Call: InitiateRecoup
ManagePendingTransactionStatus ( ManagePendingTransactionStatusReq $managePendingTransactionStatusReq, mixed $apiCredential = null ) : ManagePendingTransactionStatusResponseType Service Call: ManagePendingTransactionStatus
ManageRecurringPaymentsProfileStatus ( ManageRecurringPaymentsProfileStatusReq $manageRecurringPaymentsProfileStatusReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\ManageRecurringPaymentsProfileStatusResponseType Service Call: ManageRecurringPaymentsProfileStatus
MassPay ( MassPayReq $massPayReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\MassPayResponseType Service Call: MassPay
RefundTransaction ( RefundTransactionReq $refundTransactionReq, mixed $apiCredential = null ) : RefundTransactionResponseType Service Call: RefundTransaction
ReverseTransaction ( ReverseTransactionReq $reverseTransactionReq, mixed $apiCredential = null ) : ReverseTransactionResponseType Service Call: ReverseTransaction
SetAccessPermissions ( SetAccessPermissionsReq $setAccessPermissionsReq, mixed $apiCredential = null ) : SetAccessPermissionsResponseType Service Call: SetAccessPermissions
SetAuthFlowParam ( SetAuthFlowParamReq $setAuthFlowParamReq, mixed $apiCredential = null ) : SetAuthFlowParamResponseType Service Call: SetAuthFlowParam
SetCustomerBillingAgreement ( SetCustomerBillingAgreementReq $setCustomerBillingAgreementReq, mixed $apiCredential = null ) : SetCustomerBillingAgreementResponseType Service Call: SetCustomerBillingAgreement
SetExpressCheckout ( SetExpressCheckoutReq $setExpressCheckoutReq, mixed $apiCredential = null ) : SetExpressCheckoutResponseType Service Call: SetExpressCheckout
SetMobileCheckout ( SetMobileCheckoutReq $setMobileCheckoutReq, mixed $apiCredential = null ) : SetMobileCheckoutResponseType Service Call: SetMobileCheckout
TransactionSearch ( TransactionSearchReq $transactionSearchReq, mixed $apiCredential = null ) : TransactionSearchResponseType Service Call: TransactionSearch
UpdateAccessPermissions ( UpdateAccessPermissionsReq $updateAccessPermissionsReq, mixed $apiCredential = null ) : UpdateAccessPermissionsResponseType Service Call: UpdateAccessPermissions
UpdateAuthorization ( UpdateAuthorizationReq $updateAuthorizationReq, mixed $apiCredential = null ) : UpdateAuthorizationResponseType Service Call: UpdateAuthorization
UpdateRecurringPaymentsProfile ( UpdateRecurringPaymentsProfileReq $updateRecurringPaymentsProfileReq, mixed $apiCredential = null ) : UpdateRecurringPaymentsProfileResponseType Service Call: UpdateRecurringPaymentsProfile
__construct ( $config = null )

Private Methods

Method Description
setStandardParams ( $request )

Method Details

AddressVerify() public method

Service Call: AddressVerify
public AddressVerify ( AddressVerifyReq $addressVerifyReq, mixed $apiCredential = null ) : AddressVerifyResponseType
$addressVerifyReq PayPal\PayPalAPI\AddressVerifyReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\AddressVerifyResponseType

BillAgreementUpdate() public method

Service Call: BillAgreementUpdate
public BillAgreementUpdate ( BillAgreementUpdateReq $billAgreementUpdateReq, mixed $apiCredential = null ) : BAUpdateResponseType
$billAgreementUpdateReq PayPal\PayPalAPI\BillAgreementUpdateReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\BAUpdateResponseType

BillOutstandingAmount() public method

Service Call: BillOutstandingAmount
public BillOutstandingAmount ( BillOutstandingAmountReq $billOutstandingAmountReq, mixed $apiCredential = null ) : BillOutstandingAmountResponseType
$billOutstandingAmountReq PayPal\PayPalAPI\BillOutstandingAmountReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\BillOutstandingAmountResponseType

BillUser() public method

Service Call: BillUser
public BillUser ( BillUserReq $billUserReq, mixed $apiCredential = null ) : BillUserResponseType
$billUserReq PayPal\PayPalAPI\BillUserReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\BillUserResponseType

CancelRecoup() public method

Service Call: CancelRecoup
public CancelRecoup ( CancelRecoupReq $cancelRecoupReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\CancelRecoupResponseType
$cancelRecoupReq PayPal\PayPalAPI\CancelRecoupReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\CancelRecoupResponseType

CompleteRecoup() public method

Service Call: CompleteRecoup
public CompleteRecoup ( CompleteRecoupReq $completeRecoupReq, mixed $apiCredential = null ) : CompleteRecoupResponseType
$completeRecoupReq PayPal\PayPalAPI\CompleteRecoupReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\CompleteRecoupResponseType

CreateBillingAgreement() public method

Service Call: CreateBillingAgreement
public CreateBillingAgreement ( CreateBillingAgreementReq $createBillingAgreementReq, mixed $apiCredential = null ) : CreateBillingAgreementResponseType
$createBillingAgreementReq PayPal\PayPalAPI\CreateBillingAgreementReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\CreateBillingAgreementResponseType

CreateMobilePayment() public method

Service Call: CreateMobilePayment
public CreateMobilePayment ( CreateMobilePaymentReq $createMobilePaymentReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\CreateMobilePaymentResponseType
$createMobilePaymentReq PayPal\PayPalAPI\CreateMobilePaymentReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\CreateMobilePaymentResponseType

CreateRecurringPaymentsProfile() public method

Service Call: CreateRecurringPaymentsProfile
public CreateRecurringPaymentsProfile ( CreateRecurringPaymentsProfileReq $createRecurringPaymentsProfileReq, mixed $apiCredential = null ) : CreateRecurringPaymentsProfileResponseType
$createRecurringPaymentsProfileReq PayPal\PayPalAPI\CreateRecurringPaymentsProfileReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\CreateRecurringPaymentsProfileResponseType

DoAuthorization() public method

Service Call: DoAuthorization
public DoAuthorization ( DoAuthorizationReq $doAuthorizationReq, mixed $apiCredential = null ) : DoAuthorizationResponseType
$doAuthorizationReq PayPal\PayPalAPI\DoAuthorizationReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoAuthorizationResponseType

DoCancel() public method

Service Call: DoCancel
public DoCancel ( DoCancelReq $doCancelReq, mixed $apiCredential = null ) : DoCancelResponseType
$doCancelReq PayPal\PayPalAPI\DoCancelReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoCancelResponseType

DoCapture() public method

Service Call: DoCapture
public DoCapture ( DoCaptureReq $doCaptureReq, mixed $apiCredential = null ) : DoCaptureResponseType
$doCaptureReq PayPal\PayPalAPI\DoCaptureReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoCaptureResponseType

DoDirectPayment() public method

Service Call: DoDirectPayment
public DoDirectPayment ( DoDirectPaymentReq $doDirectPaymentReq, mixed $apiCredential = null ) : DoDirectPaymentResponseType
$doDirectPaymentReq PayPal\PayPalAPI\DoDirectPaymentReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoDirectPaymentResponseType

DoExpressCheckoutPayment() public method

Service Call: DoExpressCheckoutPayment
public DoExpressCheckoutPayment ( DoExpressCheckoutPaymentReq $doExpressCheckoutPaymentReq, mixed $apiCredential = null ) : DoExpressCheckoutPaymentResponseType
$doExpressCheckoutPaymentReq PayPal\PayPalAPI\DoExpressCheckoutPaymentReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoExpressCheckoutPaymentResponseType

DoMobileCheckoutPayment() public method

Service Call: DoMobileCheckoutPayment
public DoMobileCheckoutPayment ( DoMobileCheckoutPaymentReq $doMobileCheckoutPaymentReq, mixed $apiCredential = null ) : DoMobileCheckoutPaymentResponseType
$doMobileCheckoutPaymentReq PayPal\PayPalAPI\DoMobileCheckoutPaymentReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoMobileCheckoutPaymentResponseType

DoNonReferencedCredit() public method

Service Call: DoNonReferencedCredit
public DoNonReferencedCredit ( DoNonReferencedCreditReq $doNonReferencedCreditReq, mixed $apiCredential = null ) : DoNonReferencedCreditResponseType
$doNonReferencedCreditReq PayPal\PayPalAPI\DoNonReferencedCreditReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoNonReferencedCreditResponseType

DoReauthorization() public method

Service Call: DoReauthorization
public DoReauthorization ( DoReauthorizationReq $doReauthorizationReq, mixed $apiCredential = null ) : DoReauthorizationResponseType
$doReauthorizationReq PayPal\PayPalAPI\DoReauthorizationReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoReauthorizationResponseType

DoReferenceTransaction() public method

Service Call: DoReferenceTransaction
public DoReferenceTransaction ( DoReferenceTransactionReq $doReferenceTransactionReq, mixed $apiCredential = null ) : DoReferenceTransactionResponseType
$doReferenceTransactionReq PayPal\PayPalAPI\DoReferenceTransactionReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoReferenceTransactionResponseType

DoUATPAuthorization() public method

Service Call: DoUATPAuthorization
public DoUATPAuthorization ( DoUATPAuthorizationReq $doUATPAuthorizationReq, mixed $apiCredential = null ) : DoUATPAuthorizationResponseType
$doUATPAuthorizationReq PayPal\PayPalAPI\DoUATPAuthorizationReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoUATPAuthorizationResponseType

DoUATPExpressCheckoutPayment() public method

Service Call: DoUATPExpressCheckoutPayment
public DoUATPExpressCheckoutPayment ( DoUATPExpressCheckoutPaymentReq $doUATPExpressCheckoutPaymentReq, mixed $apiCredential = null ) : DoUATPExpressCheckoutPaymentResponseType
$doUATPExpressCheckoutPaymentReq PayPal\PayPalAPI\DoUATPExpressCheckoutPaymentReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoUATPExpressCheckoutPaymentResponseType

DoVoid() public method

Service Call: DoVoid
public DoVoid ( DoVoidReq $doVoidReq, mixed $apiCredential = null ) : DoVoidResponseType
$doVoidReq PayPal\PayPalAPI\DoVoidReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\DoVoidResponseType

EnterBoarding() public method

Service Call: EnterBoarding
public EnterBoarding ( EnterBoardingReq $enterBoardingReq, mixed $apiCredential = null ) : EnterBoardingResponseType
$enterBoardingReq PayPal\PayPalAPI\EnterBoardingReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\EnterBoardingResponseType

ExecuteCheckoutOperations() public method

Service Call: ExecuteCheckoutOperations
public ExecuteCheckoutOperations ( ExecuteCheckoutOperationsReq $executeCheckoutOperationsReq, mixed $apiCredential = null ) : ExecuteCheckoutOperationsResponseType
$executeCheckoutOperationsReq PayPal\PayPalAPI\ExecuteCheckoutOperationsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\ExecuteCheckoutOperationsResponseType

ExternalRememberMeOptOut() public method

Service Call: ExternalRememberMeOptOut
public ExternalRememberMeOptOut ( ExternalRememberMeOptOutReq $externalRememberMeOptOutReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\ExternalRememberMeOptOutResponseType
$externalRememberMeOptOutReq PayPal\PayPalAPI\ExternalRememberMeOptOutReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\ExternalRememberMeOptOutResponseType

GetAccessPermissionDetails() public method

Service Call: GetAccessPermissionDetails
public GetAccessPermissionDetails ( GetAccessPermissionDetailsReq $getAccessPermissionDetailsReq, mixed $apiCredential = null ) : GetAccessPermissionDetailsResponseType
$getAccessPermissionDetailsReq PayPal\PayPalAPI\GetAccessPermissionDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetAccessPermissionDetailsResponseType

GetAuthDetails() public method

Service Call: GetAuthDetails
public GetAuthDetails ( GetAuthDetailsReq $getAuthDetailsReq, mixed $apiCredential = null ) : GetAuthDetailsResponseType
$getAuthDetailsReq PayPal\PayPalAPI\GetAuthDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetAuthDetailsResponseType

GetBalance() public method

Service Call: GetBalance
public GetBalance ( GetBalanceReq $getBalanceReq, mixed $apiCredential = null ) : GetBalanceResponseType
$getBalanceReq PayPal\PayPalAPI\GetBalanceReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetBalanceResponseType

GetBillingAgreementCustomerDetails() public method

Service Call: GetBillingAgreementCustomerDetails
public GetBillingAgreementCustomerDetails ( GetBillingAgreementCustomerDetailsReq $getBillingAgreementCustomerDetailsReq, mixed $apiCredential = null ) : GetBillingAgreementCustomerDetailsResponseType
$getBillingAgreementCustomerDetailsReq PayPal\PayPalAPI\GetBillingAgreementCustomerDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetBillingAgreementCustomerDetailsResponseType

GetBoardingDetails() public method

Service Call: GetBoardingDetails
public GetBoardingDetails ( GetBoardingDetailsReq $getBoardingDetailsReq, mixed $apiCredential = null ) : GetBoardingDetailsResponseType
$getBoardingDetailsReq PayPal\PayPalAPI\GetBoardingDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetBoardingDetailsResponseType

GetExpressCheckoutDetails() public method

Service Call: GetExpressCheckoutDetails
public GetExpressCheckoutDetails ( GetExpressCheckoutDetailsReq $getExpressCheckoutDetailsReq, mixed $apiCredential = null ) : GetExpressCheckoutDetailsResponseType
$getExpressCheckoutDetailsReq PayPal\PayPalAPI\GetExpressCheckoutDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetExpressCheckoutDetailsResponseType

GetIncentiveEvaluation() public method

Service Call: GetIncentiveEvaluation
public GetIncentiveEvaluation ( GetIncentiveEvaluationReq $getIncentiveEvaluationReq, mixed $apiCredential = null ) : GetIncentiveEvaluationResponseType
$getIncentiveEvaluationReq PayPal\PayPalAPI\GetIncentiveEvaluationReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetIncentiveEvaluationResponseType

GetMobileStatus() public method

Service Call: GetMobileStatus
public GetMobileStatus ( GetMobileStatusReq $getMobileStatusReq, mixed $apiCredential = null ) : GetMobileStatusResponseType
$getMobileStatusReq PayPal\PayPalAPI\GetMobileStatusReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetMobileStatusResponseType

GetPalDetails() public method

Service Call: GetPalDetails
public GetPalDetails ( GetPalDetailsReq $getPalDetailsReq, mixed $apiCredential = null ) : GetPalDetailsResponseType
$getPalDetailsReq PayPal\PayPalAPI\GetPalDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetPalDetailsResponseType

GetRecurringPaymentsProfileDetails() public method

Service Call: GetRecurringPaymentsProfileDetails
public GetRecurringPaymentsProfileDetails ( GetRecurringPaymentsProfileDetailsReq $getRecurringPaymentsProfileDetailsReq, mixed $apiCredential = null ) : GetRecurringPaymentsProfileDetailsResponseType
$getRecurringPaymentsProfileDetailsReq PayPal\PayPalAPI\GetRecurringPaymentsProfileDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetRecurringPaymentsProfileDetailsResponseType

GetTransactionDetails() public method

Service Call: GetTransactionDetails
public GetTransactionDetails ( GetTransactionDetailsReq $getTransactionDetailsReq, mixed $apiCredential = null ) : GetTransactionDetailsResponseType
$getTransactionDetailsReq PayPal\PayPalAPI\GetTransactionDetailsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\GetTransactionDetailsResponseType

InitiateRecoup() public method

Service Call: InitiateRecoup
public InitiateRecoup ( InitiateRecoupReq $initiateRecoupReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\InitiateRecoupResponseType
$initiateRecoupReq PayPal\PayPalAPI\InitiateRecoupReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\InitiateRecoupResponseType

ManagePendingTransactionStatus() public method

Service Call: ManagePendingTransactionStatus
public ManagePendingTransactionStatus ( ManagePendingTransactionStatusReq $managePendingTransactionStatusReq, mixed $apiCredential = null ) : ManagePendingTransactionStatusResponseType
$managePendingTransactionStatusReq PayPal\PayPalAPI\ManagePendingTransactionStatusReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\ManagePendingTransactionStatusResponseType

ManageRecurringPaymentsProfileStatus() public method

Service Call: ManageRecurringPaymentsProfileStatus
public ManageRecurringPaymentsProfileStatus ( ManageRecurringPaymentsProfileStatusReq $manageRecurringPaymentsProfileStatusReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\ManageRecurringPaymentsProfileStatusResponseType
$manageRecurringPaymentsProfileStatusReq PayPal\PayPalAPI\ManageRecurringPaymentsProfileStatusReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\ManageRecurringPaymentsProfileStatusResponseType

MassPay() public method

Service Call: MassPay
public MassPay ( MassPayReq $massPayReq, mixed $apiCredential = null ) : PayPal\PayPalAPI\MassPayResponseType
$massPayReq PayPal\PayPalAPI\MassPayReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\MassPayResponseType

RefundTransaction() public method

Service Call: RefundTransaction
public RefundTransaction ( RefundTransactionReq $refundTransactionReq, mixed $apiCredential = null ) : RefundTransactionResponseType
$refundTransactionReq PayPal\PayPalAPI\RefundTransactionReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\RefundTransactionResponseType

ReverseTransaction() public method

Service Call: ReverseTransaction
public ReverseTransaction ( ReverseTransactionReq $reverseTransactionReq, mixed $apiCredential = null ) : ReverseTransactionResponseType
$reverseTransactionReq PayPal\PayPalAPI\ReverseTransactionReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\ReverseTransactionResponseType

SetAccessPermissions() public method

Service Call: SetAccessPermissions
public SetAccessPermissions ( SetAccessPermissionsReq $setAccessPermissionsReq, mixed $apiCredential = null ) : SetAccessPermissionsResponseType
$setAccessPermissionsReq PayPal\PayPalAPI\SetAccessPermissionsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\SetAccessPermissionsResponseType

SetAuthFlowParam() public method

Service Call: SetAuthFlowParam
public SetAuthFlowParam ( SetAuthFlowParamReq $setAuthFlowParamReq, mixed $apiCredential = null ) : SetAuthFlowParamResponseType
$setAuthFlowParamReq PayPal\PayPalAPI\SetAuthFlowParamReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\SetAuthFlowParamResponseType

SetCustomerBillingAgreement() public method

Service Call: SetCustomerBillingAgreement
public SetCustomerBillingAgreement ( SetCustomerBillingAgreementReq $setCustomerBillingAgreementReq, mixed $apiCredential = null ) : SetCustomerBillingAgreementResponseType
$setCustomerBillingAgreementReq PayPal\PayPalAPI\SetCustomerBillingAgreementReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\SetCustomerBillingAgreementResponseType

SetExpressCheckout() public method

Service Call: SetExpressCheckout
public SetExpressCheckout ( SetExpressCheckoutReq $setExpressCheckoutReq, mixed $apiCredential = null ) : SetExpressCheckoutResponseType
$setExpressCheckoutReq PayPal\PayPalAPI\SetExpressCheckoutReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\SetExpressCheckoutResponseType

SetMobileCheckout() public method

Service Call: SetMobileCheckout
public SetMobileCheckout ( SetMobileCheckoutReq $setMobileCheckoutReq, mixed $apiCredential = null ) : SetMobileCheckoutResponseType
$setMobileCheckoutReq PayPal\PayPalAPI\SetMobileCheckoutReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\SetMobileCheckoutResponseType

TransactionSearch() public method

Service Call: TransactionSearch
public TransactionSearch ( TransactionSearchReq $transactionSearchReq, mixed $apiCredential = null ) : TransactionSearchResponseType
$transactionSearchReq PayPal\PayPalAPI\TransactionSearchReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\TransactionSearchResponseType

UpdateAccessPermissions() public method

Service Call: UpdateAccessPermissions
public UpdateAccessPermissions ( UpdateAccessPermissionsReq $updateAccessPermissionsReq, mixed $apiCredential = null ) : UpdateAccessPermissionsResponseType
$updateAccessPermissionsReq PayPal\PayPalAPI\UpdateAccessPermissionsReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\UpdateAccessPermissionsResponseType

UpdateAuthorization() public method

Service Call: UpdateAuthorization
public UpdateAuthorization ( UpdateAuthorizationReq $updateAuthorizationReq, mixed $apiCredential = null ) : UpdateAuthorizationResponseType
$updateAuthorizationReq PayPal\PayPalAPI\UpdateAuthorizationReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\UpdateAuthorizationResponseType

UpdateRecurringPaymentsProfile() public method

Service Call: UpdateRecurringPaymentsProfile
public UpdateRecurringPaymentsProfile ( UpdateRecurringPaymentsProfileReq $updateRecurringPaymentsProfileReq, mixed $apiCredential = null ) : UpdateRecurringPaymentsProfileResponseType
$updateRecurringPaymentsProfileReq PayPal\PayPalAPI\UpdateRecurringPaymentsProfileReq
$apiCredential mixed - Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return PayPal\PayPalAPI\UpdateRecurringPaymentsProfileResponseType

__construct() public method

public __construct ( $config = null )
$config - Dynamic config map. This takes the higher precedence if config file is also present.

Property Details

$SDK_NAME protected static property

SDK Name
protected static $SDK_NAME

$SDK_VERSION protected static property

SDK Version
protected static $SDK_VERSION