Package DE_EPAGES::AmazonPayments::API::Object::AmazonRestClient
Client for Amazon Payments
Base |
DE_EPAGES::EPagesJ::API::Object::RestClient |
Functions
- authorize
- cancelOrder
- capture
- check
- closeAuthorization
- closeOrder
- confirmOrder
- create
- getAuthorizationDetails
- getCaptureDetails
- getOrderDetails
- new
- setOrderDetails
authorize
Request authorization to capture money for an order
Syntax |
$Status = $Client->authorize($refId, $authRefId, $amount, $currency); |
Input |
|
Return |
|
cancelOrder
Cancels an order
Syntax |
$Client->cancelOrder($orderRefId); |
Input |
|
capture
Capture an order amount from Amazon
Syntax |
$CaptureDetails = $Client->capture($authId); |
Input |
|
Return |
|
check
Performs a REST call to the EpagesJ payment/amazon/check resource to validate payment credentials
Syntax |
$Status = $Client->check(); |
Return |
|
closeAuthorization
Closes an authorization. Call this when no more captures will be done against the authorization
Syntax |
$Client->closeAuthorization($authId); |
Input |
|
closeOrder
Close an order
Syntax |
$Client->closeOrder($orderRefId); |
Input |
|
confirmOrder
Confirm the order and put it in Status ORDER_OPEN
Syntax |
$Status = $Client->confirmOrder($refId); |
Input |
|
Return |
|
create
Factory method for a AmazonRestClient object.
Syntax |
$RestClient = DE_EPAGES::AmazonPayments::API::Object::AmazonRestClient->create($PaymentMethod, $hArgs); |
Input |
|
Return |
|
getAuthorizationDetails
Request information about an Amazon capture authorization
Syntax |
$Status = $Client->getAuthorizationDetails($authId); |
Input |
|
Return |
|
getCaptureDetails
Get detail information about a capture
Syntax |
$CaptureDetails = $Client->getCaptureDetails($captureId); |
Input |
|
Return |
|
getOrderDetails
Get detailed information about an Amazon Order Reference
Syntax |
$OrderReferenceInfo = $Client->getOrderDetails($refId); |
Input |
|
Return |
|
new
Webservice client constructor
Syntax |
DE_EPAGES::AmazonPayments::API::Object::AmazonRestClient->new( %args ); |
Input |
|
Return |
|
setOrderDetails
Set details on an Amazon Order Reference
Syntax |
$Status = $Client->setOrderDetails($refId, $hArgs); |
Input |
|
Return |
|