Overview

Classes

  • Syspay_Merchant_AstroPayBanksRequest
  • Syspay_Merchant_BillingAgreementCancellationRequest
  • Syspay_Merchant_BillingAgreementInfoRequest
  • Syspay_Merchant_BillingAgreementListRequest
  • Syspay_Merchant_BillingAgreementRequest
  • Syspay_Merchant_ChargebackInfoRequest
  • Syspay_Merchant_ChargebackListRequest
  • Syspay_Merchant_Client
  • Syspay_Merchant_ConfirmRequest
  • Syspay_Merchant_EMS
  • Syspay_Merchant_Entity
  • Syspay_Merchant_Entity_AstroPayBank
  • Syspay_Merchant_Entity_BillingAgreement
  • Syspay_Merchant_Entity_Chargeback
  • Syspay_Merchant_Entity_Creditcard
  • Syspay_Merchant_Entity_Customer
  • Syspay_Merchant_Entity_Eterminal
  • Syspay_Merchant_Entity_Payment
  • Syspay_Merchant_Entity_PaymentMethod
  • Syspay_Merchant_Entity_PaymentRecipient
  • Syspay_Merchant_Entity_Plan
  • Syspay_Merchant_Entity_Refund
  • Syspay_Merchant_Entity_Subscription
  • Syspay_Merchant_Entity_SubscriptionEvent
  • Syspay_Merchant_EterminalRequest
  • Syspay_Merchant_IpAddressesRequest
  • Syspay_Merchant_PaymentInfoRequest
  • Syspay_Merchant_PaymentListRequest
  • Syspay_Merchant_PaymentRequest
  • Syspay_Merchant_PlanInfoRequest
  • Syspay_Merchant_PlanRequest
  • Syspay_Merchant_PlanUpdateRequest
  • Syspay_Merchant_RebillRequest
  • Syspay_Merchant_Redirect
  • Syspay_Merchant_RefundInfoRequest
  • Syspay_Merchant_RefundListRequest
  • Syspay_Merchant_RefundRequest
  • Syspay_Merchant_Request
  • Syspay_Merchant_SubscriptionCancellationRequest
  • Syspay_Merchant_SubscriptionInfoRequest
  • Syspay_Merchant_SubscriptionRebillRequest
  • Syspay_Merchant_SubscriptionRequest
  • Syspay_Merchant_Utils
  • Syspay_Merchant_VoidRequest

Interfaces

  • Syspay_Merchant_Entity_ReturnedEntityInterface

Exceptions

  • Syspay_Merchant_EMSException
  • Syspay_Merchant_RedirectException
  • Syspay_Merchant_RequestException
  • Syspay_Merchant_UnexpectedResponseException
  • Overview
  • Class
  • Tree

Class Syspay_Merchant_EterminalRequest

Create an eterminal instance

Syspay_Merchant_Request
Extended by Syspay_Merchant_EterminalRequest
See: https://app.syspay.com/bundles/emiuser/doc/merchant_eterminal.html
Located at Syspay/SDK/Merchant/Request/Eterminal.php
Methods summary
public string
# getMethod( )

Get the HTTP method to use to make the request

Get the HTTP method to use to make the request

Returns

string
HTTP method
public string
# getPath( )

Get the path to call to make the request

Get the path to call to make the request

Returns

string
API path
public mixed
# buildResponse( stdClass $response )

Build an object based on the decoded response received from the API (turned to a stdClass object)

Build an object based on the decoded response received from the API (turned to a stdClass object)

Parameters

$response
The data to build the object from

Returns

mixed
The object built
public integer
# getWebsite( )

Gets the value of website.

Gets the value of website.

Returns

integer
integer
public Syspay_Merchant_EterminalRequest
# setWebsite( integer $website )

Sets the value of website.

Sets the value of website.

Parameters

$website
the website id

Returns

Syspay_Merchant_EterminalRequest
self
public integer
# getAllowedRetries( )

Gets the value of allowedRetries.

Gets the value of allowedRetries.

Returns

integer
integer
public Syspay_Merchant_EterminalRequest
# setAllowedRetries( integer $allowedRetries )

Sets the value of allowedRetries.

Sets the value of allowedRetries.

Parameters

$allowedRetries

Returns

Syspay_Merchant_EterminalRequest
self
public boolean
# getLocked( )

Gets the value of locked.

Gets the value of locked.

Returns

boolean
boolean
public Syspay_Merchant_EterminalRequest
# setLocked( boolean $locked )

Sets the value of locked.

Sets the value of locked.

Parameters

$locked
the locked

Returns

Syspay_Merchant_EterminalRequest
self
public string
# getEmsUrl( )

Gets the value of emsUrl.

Gets the value of emsUrl.

Returns

string
string
public Syspay_Merchant_EterminalRequest
# setEmsUrl( string $emsUrl )

Sets the value of emsUrl.

Sets the value of emsUrl.

Parameters

$emsUrl
the emsUrl

Returns

Syspay_Merchant_EterminalRequest
self
public string
# getPaymentRedirectUrl( )

Gets the value of paymentRedirectUrl.

Gets the value of paymentRedirectUrl.

Returns

string
string
public Syspay_Merchant_EterminalRequest
# setPaymentRedirectUrl( string $paymentRedirectUrl )

Sets the value of paymentRedirectUrl.

Sets the value of paymentRedirectUrl.

Parameters

$paymentRedirectUrl
the paymentRedirectUrl

Returns

Syspay_Merchant_EterminalRequest
self
public string
# getEterminalRedirectUrl( )

Gets the value of PostProcessRedirectUrl.

Gets the value of PostProcessRedirectUrl.

Returns

string
string
public Syspay_Merchant_EterminalRequest
# setEterminalRedirectUrl( string $eterminalRedirectUrl )

Sets the value of postProcessRedirectUrl.

Sets the value of postProcessRedirectUrl.

Parameters

$eterminalRedirectUrl
$postProcessRedirectUrl the postProcessRedirectUrl

Returns

Syspay_Merchant_EterminalRequest
self
public string
# getType( )

Gets the value of type.

Gets the value of type.

Returns

string
string
public Syspay_Merchant_EterminalRequest
# setType( string $type )

Sets the value of type.

Sets the value of type.

Parameters

$type
the type

Returns

Syspay_Merchant_EterminalRequest
self
public string
# getDescription( )

Gets the value of description.

Gets the value of description.

Returns

string
string
public Syspay_Merchant_EterminalRequest
# setDescription( string $description )

Sets the value of description.

Sets the value of description.

Parameters

$description
the description

Returns

Syspay_Merchant_EterminalRequest
self
public string
# getReference( )

Gets the value of reference.

Gets the value of reference.

Returns

string
string
public Syspay_Merchant_EterminalRequest
# setReference( string $reference )

Sets the value of reference.

Sets the value of reference.

Parameters

$reference
the reference

Returns

Syspay_Merchant_EterminalRequest
self
public array
# getCustomer( )

Gets the value of customer.

Gets the value of customer.

Returns

array
array
public Syspay_Merchant_EterminalRequest
# setCustomer( array $customer )

Sets the value of customer.

Sets the value of customer.

Parameters

$customer
the customer

Returns

Syspay_Merchant_EterminalRequest
self
public array
# getOneshot( )

Gets the value of oneshot.

Gets the value of oneshot.

Returns

array
array
public Syspay_Merchant_EterminalRequest
# setOneshot( array $oneshot )

Sets the value of oneshot.

Sets the value of oneshot.

Parameters

$oneshot
the oneshot

Returns

Syspay_Merchant_EterminalRequest
self
public array
# getSubscription( )

Gets the value of subscription.

Gets the value of subscription.

Returns

array
array
public Syspay_Merchant_EterminalRequest
# setSubscription( array $subscription )

Sets the value of subscription.

Sets the value of subscription.

Parameters

$subscription
the subscription

Returns

Syspay_Merchant_EterminalRequest
self
public array
# getPaymentPlan( )

Gets the value of paymentPlan.

Gets the value of paymentPlan.

Returns

array
array
public Syspay_Merchant_EterminalRequest
# setPaymentPlan( array $paymentPlan )

Sets the value of paymentPlan.

Sets the value of paymentPlan.

Parameters

$paymentPlan
the paymentPlan

Returns

Syspay_Merchant_EterminalRequest
self
public array
# getPaymentMandate( )

Gets the value of paymentMandate.

Gets the value of paymentMandate.

Returns

array
array
public Syspay_Merchant_EterminalRequest
# setPaymentMandate( array $paymentMandate )

Sets the value of paymentMandate.

Sets the value of paymentMandate.

Parameters

$paymentMandate
the paymentMandate

Returns

Syspay_Merchant_EterminalRequest
self
public array
# getData( )

Get the data to send to the API for the request

Get the data to send to the API for the request

Returns

array
An array of data that will be json-encoded by the Syspay_Merchant_Client

Overrides

Syspay_Merchant_Request::getData()
Constants summary
string METHOD
#'POST'
string PATH
#'/api/v1/merchant/eterminal'
string TYPE_ONESHOT
#'ONESHOT'
string TYPE_SUBSCRIPTION
#'SUBSCRIPTION'
string TYPE_PAYMENT_PLAN
#'PAYMENT_PLAN'
string TYPE_PAYMENT_MANDATE
#'PAYMENT_MANDATE'
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0