PHP Class PayPal\Service\AdaptivePaymentsService

Inheritance: extends PayPal\Core\PPBaseService

Show file Open project: paypal/adaptivepayments-sdk-php Class Usage Examples

Protected Properties

Property	Type	Description
$SDK_NAME		SDK Name
$SDK_VERSION		SDK Version

Public Methods

Method	Description
CancelPreapproval ( CancelPreapprovalRequest $cancelPreapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\CancelPreapprovalResponse	Service Call: CancelPreapproval
ConfirmPreapproval ( ConfirmPreapprovalRequest $confirmPreapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\ConfirmPreapprovalResponse	Service Call: ConfirmPreapproval
ConvertCurrency ( ConvertCurrencyRequest $convertCurrencyRequest, mixed $apiCredential = NULL ) : Types\AP\ConvertCurrencyResponse	Service Call: ConvertCurrency
ExecutePayment ( ExecutePaymentRequest $executePaymentRequest, mixed $apiCredential = NULL ) : Types\AP\ExecutePaymentResponse	Service Call: ExecutePayment
GetAllowedFundingSources ( GetAllowedFundingSourcesRequest $getAllowedFundingSourcesRequest, mixed $apiCredential = NULL ) : Types\AP\GetAllowedFundingSourcesResponse	Service Call: GetAllowedFundingSources
GetAvailableShippingAddresses ( GetAvailableShippingAddressesRequest $getAvailableShippingAddressesRequest, mixed $apiCredential = NULL ) : Types\AP\GetAvailableShippingAddressesResponse	Service Call: GetAvailableShippingAddresses
GetFundingPlans ( GetFundingPlansRequest $getFundingPlansRequest, mixed $apiCredential = NULL ) : Types\AP\GetFundingPlansResponse	Service Call: GetFundingPlans
GetPaymentOptions ( GetPaymentOptionsRequest $getPaymentOptionsRequest, mixed $apiCredential = NULL ) : Types\AP\GetPaymentOptionsResponse	Service Call: GetPaymentOptions
GetPrePaymentDisclosure ( GetPrePaymentDisclosureRequest $getPrePaymentDisclosureRequest, mixed $apiCredential = NULL ) : Types\AP\GetPrePaymentDisclosureResponse	Service Call: GetPrePaymentDisclosure
GetShippingAddresses ( GetShippingAddressesRequest $getShippingAddressesRequest, mixed $apiCredential = NULL ) : Types\AP\GetShippingAddressesResponse	Service Call: GetShippingAddresses
GetUserLimits ( GetUserLimitsRequest $getUserLimitsRequest, mixed $apiCredential = NULL ) : Types\AP\GetUserLimitsResponse	Service Call: GetUserLimits
Pay ( PayRequest $payRequest, mixed $apiCredential = NULL ) : Types\AP\PayResponse	Service Call: Pay
PaymentDetails ( PaymentDetailsRequest $paymentDetailsRequest, mixed $apiCredential = NULL ) : Types\AP\PaymentDetailsResponse	Service Call: PaymentDetails
Preapproval ( PreapprovalRequest $preapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\PreapprovalResponse	Service Call: Preapproval
PreapprovalDetails ( PreapprovalDetailsRequest $preapprovalDetailsRequest, mixed $apiCredential = NULL ) : Types\AP\PreapprovalDetailsResponse	Service Call: PreapprovalDetails
Refund ( RefundRequest $refundRequest, mixed $apiCredential = NULL ) : Types\AP\RefundResponse	Service Call: Refund
SetPaymentOptions ( SetPaymentOptionsRequest $setPaymentOptionsRequest, mixed $apiCredential = NULL ) : Types\AP\SetPaymentOptionsResponse	Service Call: SetPaymentOptions
__construct ( $config = null )

Method Details

CancelPreapproval() public method

Service Call: CancelPreapproval

public CancelPreapproval ( CancelPreapprovalRequest $cancelPreapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\CancelPreapprovalResponse
$cancelPreapprovalRequest	CancelPreapprovalRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\CancelPreapprovalResponse

ConfirmPreapproval() public method

Service Call: ConfirmPreapproval

public ConfirmPreapproval ( ConfirmPreapprovalRequest $confirmPreapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\ConfirmPreapprovalResponse
$confirmPreapprovalRequest	ConfirmPreapprovalRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\ConfirmPreapprovalResponse

ConvertCurrency() public method

Service Call: ConvertCurrency

public ConvertCurrency ( ConvertCurrencyRequest $convertCurrencyRequest, mixed $apiCredential = NULL ) : Types\AP\ConvertCurrencyResponse
$convertCurrencyRequest	ConvertCurrencyRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\ConvertCurrencyResponse

ExecutePayment() public method

Service Call: ExecutePayment

public ExecutePayment ( ExecutePaymentRequest $executePaymentRequest, mixed $apiCredential = NULL ) : Types\AP\ExecutePaymentResponse
$executePaymentRequest	ExecutePaymentRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\ExecutePaymentResponse

GetAllowedFundingSources() public method

Service Call: GetAllowedFundingSources

public GetAllowedFundingSources ( GetAllowedFundingSourcesRequest $getAllowedFundingSourcesRequest, mixed $apiCredential = NULL ) : Types\AP\GetAllowedFundingSourcesResponse
$getAllowedFundingSourcesRequest	GetAllowedFundingSourcesRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetAllowedFundingSourcesResponse

GetAvailableShippingAddresses() public method

Service Call: GetAvailableShippingAddresses

public GetAvailableShippingAddresses ( GetAvailableShippingAddressesRequest $getAvailableShippingAddressesRequest, mixed $apiCredential = NULL ) : Types\AP\GetAvailableShippingAddressesResponse
$getAvailableShippingAddressesRequest	GetAvailableShippingAddressesRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetAvailableShippingAddressesResponse

GetFundingPlans() public method

Service Call: GetFundingPlans

public GetFundingPlans ( GetFundingPlansRequest $getFundingPlansRequest, mixed $apiCredential = NULL ) : Types\AP\GetFundingPlansResponse
$getFundingPlansRequest	GetFundingPlansRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetFundingPlansResponse

GetPaymentOptions() public method

Service Call: GetPaymentOptions

public GetPaymentOptions ( GetPaymentOptionsRequest $getPaymentOptionsRequest, mixed $apiCredential = NULL ) : Types\AP\GetPaymentOptionsResponse
$getPaymentOptionsRequest	GetPaymentOptionsRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetPaymentOptionsResponse

GetPrePaymentDisclosure() public method

Service Call: GetPrePaymentDisclosure

public GetPrePaymentDisclosure ( GetPrePaymentDisclosureRequest $getPrePaymentDisclosureRequest, mixed $apiCredential = NULL ) : Types\AP\GetPrePaymentDisclosureResponse
$getPrePaymentDisclosureRequest	GetPrePaymentDisclosureRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetPrePaymentDisclosureResponse

GetShippingAddresses() public method

Service Call: GetShippingAddresses

public GetShippingAddresses ( GetShippingAddressesRequest $getShippingAddressesRequest, mixed $apiCredential = NULL ) : Types\AP\GetShippingAddressesResponse
$getShippingAddressesRequest	GetShippingAddressesRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetShippingAddressesResponse

GetUserLimits() public method

Service Call: GetUserLimits

public GetUserLimits ( GetUserLimitsRequest $getUserLimitsRequest, mixed $apiCredential = NULL ) : Types\AP\GetUserLimitsResponse
$getUserLimitsRequest	GetUserLimitsRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\GetUserLimitsResponse

Pay() public method

Service Call: Pay

public Pay ( PayRequest $payRequest, mixed $apiCredential = NULL ) : Types\AP\PayResponse
$payRequest	PayRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\PayResponse

PaymentDetails() public method

Service Call: PaymentDetails

public PaymentDetails ( PaymentDetailsRequest $paymentDetailsRequest, mixed $apiCredential = NULL ) : Types\AP\PaymentDetailsResponse
$paymentDetailsRequest	PaymentDetailsRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\PaymentDetailsResponse

Preapproval() public method

Service Call: Preapproval

public Preapproval ( PreapprovalRequest $preapprovalRequest, mixed $apiCredential = NULL ) : Types\AP\PreapprovalResponse
$preapprovalRequest	PreapprovalRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\PreapprovalResponse

PreapprovalDetails() public method

Service Call: PreapprovalDetails

public PreapprovalDetails ( PreapprovalDetailsRequest $preapprovalDetailsRequest, mixed $apiCredential = NULL ) : Types\AP\PreapprovalDetailsResponse
$preapprovalDetailsRequest	PreapprovalDetailsRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\PreapprovalDetailsResponse

Refund() public method

Service Call: Refund

public Refund ( RefundRequest $refundRequest, mixed $apiCredential = NULL ) : Types\AP\RefundResponse
$refundRequest	RefundRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\RefundResponse

SetPaymentOptions() public method

Service Call: SetPaymentOptions

public SetPaymentOptions ( SetPaymentOptionsRequest $setPaymentOptionsRequest, mixed $apiCredential = NULL ) : Types\AP\SetPaymentOptionsResponse
$setPaymentOptionsRequest	SetPaymentOptionsRequest
$apiCredential	mixed	- Optional API credential - can either be a username configured in sdk_config.ini or a ICredential object created dynamically
return	Types\AP\SetPaymentOptionsResponse

__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