PHP Interface PayWithAmazon\ClientInterface

Afficher le fichier Open project: amzn/login-and-pay-with-amazon-sdk-php

Méthodes publiques

Méthode Description
__get ( $name ) * Getter Gets the value for the key if the key exists in config
authorize ( $requestParameters = [] ) * Authorize API call - Reserves a specified amount against the payment method(s) stored in the order reference.
authorizeOnBillingAgreement ( $requestParameters = [] ) * AuthorizeOnBillingAgreement API call - Reserves a specified amount against the payment method(s) stored in the Billing Agreement.
cancelOrderReference ( $requestParameters = [] ) * CancelOrderReferenceDetails API call - Cancels a previously confirmed order reference.
capture ( $requestParameters = [] ) * Capture API call - Captures funds from an authorized payment instrument.
charge ( $requestParameters = [] ) * charge convenience method Performs the API calls 1. SetOrderReferenceDetails / SetBillingAgreementDetails 2. ConfirmOrderReference / ConfirmBillingAgreement 3. Authorize (with Capture) / AuthorizeOnBillingAgreeemnt (with Capture)
closeAuthorization ( $requestParameters = [] ) * CloseAuthorization API call - Closes an authorization.
closeBillingAgreement ( $requestParameters = [] ) * CloseBillingAgreement API Call - Returns details about the Billing Agreement object and its current state.
closeOrderReference ( $requestParameters = [] ) * CloseOrderReferenceDetails API call - Confirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference.
confirmBillingAgreement ( $requestParameters = [] ) * ConfirmBillingAgreement API Call - Confirms that the Billing Agreement is free of constraints and all required information has been set on the Billing Agreement.
confirmOrderReference ( $requestParameters = [] ) * ConfirmOrderReferenceDetails API call - Confirms that the order reference is free of constraints and all required information has been set on the order reference.
createOrderReferenceForId ( $requestParameters = [] ) * CreateOrderReferenceForId API Call - Creates an order reference for the given object
getAuthorizationDetails ( $requestParameters = [] ) * GetAuthorizationDetails API call - Returns the status of a particular authorization and the total amount captured on the authorization.
getBillingAgreementDetails ( $requestParameters = [] ) * GetBillingAgreementDetails API Call - Returns details about the Billing Agreement object and its current state.
getCaptureDetails ( $requestParameters = [] ) * GetCaptureDetails API call - Returns the status of a particular capture and the total amount refunded on the capture.
getOrderReferenceDetails ( $requestParameters = [] ) * GetOrderReferenceDetails API call - Returns details about the Order Reference object and its current state.
getParameters ( ) * Getter for parameters string Gets the value for the parameters string for unit testing
getProviderCreditDetails ( $requestParameters = [] ) * GetProviderCreditDetails API Call - Get the details of the Provider Credit.
getProviderCreditReversalDetails ( $requestParameters = [] ) * GetProviderCreditReversalDetails API Call - Get details of the Provider Credit Reversal.
getRefundDetails ( $requestParameters = [] ) * GetRefundDetails API call - Returns the status of a particular refund.
getServiceStatus ( $requestParameters = [] ) * GetServiceStatus API Call - Returns the operational status of the Off-Amazon Payments API section
getUserInfo ( $access_token ) * GetUserInfo convenience funtion - Returns user's profile information from Amazon using the access token returned by the Button widget.
refund ( $requestParameters = [] ) * Refund API call - Refunds a previously captured amount.
reverseProviderCredit ( $requestParameters = [] ) * ReverseProviderCredit API Call - Reverse the Provider Credit.
setBillingAgreementDetails ( $requestParameters = [] ) * SetBillingAgreementDetails API call - Sets Billing Agreement details such as a description of the agreement and other information about the seller.
setClientId ( $value ) * Setter for config['client_id'] Sets the value for config['client_id'] variable
setMwsServiceUrl ( $url ) * Setter for $_mwsServiceUrl Set the URL to which the post request has to be made for unit testing
setOrderReferenceDetails ( $requestParameters = [] ) * SetOrderReferenceDetails API call - Sets order reference details such as the order total and a description for the order.
setProxy ( $proxy ) * Setter for Proxy input $proxy [array]
setSandbox ( $value ) * Setter for sandbox Sets the boolean value for config['sandbox'] variable
validateBillingAgreement ( $requestParameters = [] ) * ValidateBillingAgreement API Call - Validates the status of the Billing Agreement object and the payment method associated with it.

Method Details

__get() public méthode

* Getter Gets the value for the key if the key exists in config
public __get ( $name )

authorize() public méthode

* Authorize API call - Reserves a specified amount against the payment method(s) stored in the order reference.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_Authorize.html
public authorize ( $requestParameters = [] )

authorizeOnBillingAgreement() public méthode

* AuthorizeOnBillingAgreement API call - Reserves a specified amount against the payment method(s) stored in the Billing Agreement.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_AuthorizeOnBillingAgreement.html
public authorizeOnBillingAgreement ( $requestParameters = [] )

cancelOrderReference() public méthode

* CancelOrderReferenceDetails API call - Cancels a previously confirmed order reference.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CancelOrderReference.html
public cancelOrderReference ( $requestParameters = [] )

capture() public méthode

* Capture API call - Captures funds from an authorized payment instrument.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_Capture.html
public capture ( $requestParameters = [] )

charge() public méthode

* charge convenience method Performs the API calls 1. SetOrderReferenceDetails / SetBillingAgreementDetails 2. ConfirmOrderReference / ConfirmBillingAgreement 3. Authorize (with Capture) / AuthorizeOnBillingAgreeemnt (with Capture)
public charge ( $requestParameters = [] )

closeAuthorization() public méthode

* CloseAuthorization API call - Closes an authorization.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseOrderReference.html
public closeAuthorization ( $requestParameters = [] )

closeBillingAgreement() public méthode

* CloseBillingAgreement API Call - Returns details about the Billing Agreement object and its current state.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseBillingAgreement.html
public closeBillingAgreement ( $requestParameters = [] )

closeOrderReference() public méthode

* CloseOrderReferenceDetails API call - Confirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseOrderReference.html
public closeOrderReference ( $requestParameters = [] )

confirmBillingAgreement() public méthode

* ConfirmBillingAgreement API Call - Confirms that the Billing Agreement is free of constraints and all required information has been set on the Billing Agreement.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ConfirmBillingAgreement.html
public confirmBillingAgreement ( $requestParameters = [] )

confirmOrderReference() public méthode

* ConfirmOrderReferenceDetails API call - Confirms that the order reference is free of constraints and all required information has been set on the order reference.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ConfirmOrderReference.html
public confirmOrderReference ( $requestParameters = [] )

createOrderReferenceForId() public méthode

* CreateOrderReferenceForId API Call - Creates an order reference for the given object
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CreateOrderReferenceForId.html
public createOrderReferenceForId ( $requestParameters = [] )

getAuthorizationDetails() public méthode

* GetAuthorizationDetails API call - Returns the status of a particular authorization and the total amount captured on the authorization.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetAuthorizationDetails.html
public getAuthorizationDetails ( $requestParameters = [] )

getBillingAgreementDetails() public méthode

* GetBillingAgreementDetails API Call - Returns details about the Billing Agreement object and its current state.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetBillingAgreementDetails.html
public getBillingAgreementDetails ( $requestParameters = [] )

getCaptureDetails() public méthode

* GetCaptureDetails API call - Returns the status of a particular capture and the total amount refunded on the capture.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetCaptureDetails.html
public getCaptureDetails ( $requestParameters = [] )

getOrderReferenceDetails() public méthode

* GetOrderReferenceDetails API call - Returns details about the Order Reference object and its current state.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetOrderReferenceDetails.html
public getOrderReferenceDetails ( $requestParameters = [] )

getParameters() public méthode

* Getter for parameters string Gets the value for the parameters string for unit testing
public getParameters ( )

getProviderCreditDetails() public méthode

* GetProviderCreditDetails API Call - Get the details of the Provider Credit.
public getProviderCreditDetails ( $requestParameters = [] )

getProviderCreditReversalDetails() public méthode

* GetProviderCreditReversalDetails API Call - Get details of the Provider Credit Reversal.
public getProviderCreditReversalDetails ( $requestParameters = [] )

getRefundDetails() public méthode

* GetRefundDetails API call - Returns the status of a particular refund.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetRefundDetails.html
public getRefundDetails ( $requestParameters = [] )

getServiceStatus() public méthode

* GetServiceStatus API Call - Returns the operational status of the Off-Amazon Payments API section
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetServiceStatus.html The GetServiceStatus operation returns the operational status of the Off-Amazon Payments API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, GREEN_I, YELLOW, and RED.
public getServiceStatus ( $requestParameters = [] )

getUserInfo() public méthode

* GetUserInfo convenience funtion - Returns user's profile information from Amazon using the access token returned by the Button widget.
See also: http://docs.developer.amazonservices.com/en_US/apa_guide/APAGuide_ObtainProfile.html
public getUserInfo ( $access_token )
$access_token [String]

refund() public méthode

* Refund API call - Refunds a previously captured amount.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_Refund.html
public refund ( $requestParameters = [] )

reverseProviderCredit() public méthode

* ReverseProviderCredit API Call - Reverse the Provider Credit.
public reverseProviderCredit ( $requestParameters = [] )

setBillingAgreementDetails() public méthode

* SetBillingAgreementDetails API call - Sets Billing Agreement details such as a description of the agreement and other information about the seller.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_SetBillingAgreementDetails.html
public setBillingAgreementDetails ( $requestParameters = [] )

setClientId() public méthode

* Setter for config['client_id'] Sets the value for config['client_id'] variable
public setClientId ( $value )

setMwsServiceUrl() public méthode

* Setter for $_mwsServiceUrl Set the URL to which the post request has to be made for unit testing
public setMwsServiceUrl ( $url )

setOrderReferenceDetails() public méthode

* SetOrderReferenceDetails API call - Sets order reference details such as the order total and a description for the order.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_SetOrderReferenceDetails.html
public setOrderReferenceDetails ( $requestParameters = [] )

setProxy() public méthode

* Setter for Proxy input $proxy [array]
public setProxy ( $proxy )

setSandbox() public méthode

* Setter for sandbox Sets the boolean value for config['sandbox'] variable
public setSandbox ( $value )

validateBillingAgreement() public méthode

* ValidateBillingAgreement API Call - Validates the status of the Billing Agreement object and the payment method associated with it.
See also: http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ValidateBillignAgreement.html
public validateBillingAgreement ( $requestParameters = [] )