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_Entity_BillingAgreement

A billing agreement object

Syspay_Merchant_Entity
Extended by Syspay_Merchant_Entity_BillingAgreement implements Syspay_Merchant_Entity_ReturnedEntityInterface
Located at Syspay/SDK/Merchant/Entity/BillingAgreement.php
Methods summary
public integer
# getId( )

Gets the value of id.

Gets the value of id.

Returns

integer
integer
public Syspay_Merchant_Entity_BillingAgreement
# setId( integer $id )

Sets the value of id.

Sets the value of id.

Parameters

$id
the id

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public string
# getStatus( )

Gets the value of status.

Gets the value of status.

Returns

string
string
public Syspay_Merchant_Entity_BillingAgreement
# setStatus( string $status )

Sets the value of status.

Sets the value of status.

Parameters

$status
the status

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public string
# getCurrency( )

Gets the value of currency.

Gets the value of currency.

Returns

string
string
public Syspay_Merchant_Entity_BillingAgreement
# setCurrency( string $currency )

Sets the value of currency.

Sets the value of currency.

Parameters

$currency
the currency

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public string
# getExtra( )

Gets the value of extra.

Gets the value of extra.

Returns

string
string
public Syspay_Merchant_Entity_BillingAgreement
# setExtra( string $extra )

Sets the value of extra.

Sets the value of extra.

Parameters

$extra
the extra

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public static Syspay_Merchant_Entity_BillingAgreement
# buildFromResponse( stdClass $response )

Build a billing agreement entity based on a json-decoded billing agreement stdClass

Build a billing agreement entity based on a json-decoded billing agreement stdClass

Parameters

$response
The billing agreement data

Returns

Syspay_Merchant_Entity_BillingAgreement
The billing agreement object

Implementation of

Syspay_Merchant_Entity_ReturnedEntityInterface::buildFromResponse()
public string
# getEndReason( )

Gets the value of endReason.

Gets the value of endReason.

Returns

string
string
public Syspay_Merchant_Entity_BillingAgreement
# setEndReason( string $endReason )

Sets the value of endReason.

Sets the value of endReason.

Parameters

$endReason
the endReason

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public Syspay_Merchant_Entity_Customer
# getCustomer( )

Gets the value of customer.

Gets the value of customer.

Returns

Syspay_Merchant_Entity_Customer
Syspay_Merchant_Entity_Customer
public Syspay_Merchant_Entity_BillingAgreement
# setCustomer( Syspay_Merchant_Entity_Customer $customer )

Sets the value of customer.

Sets the value of customer.

Parameters

$customer
the customer

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public Syspay_Merchant_Entity_PaymentMethod
# getPaymentMethod( )

Gets the value of payment_method.

Gets the value of payment_method.

Returns

Syspay_Merchant_Entity_PaymentMethod
Syspay_Merchant_Entity_PaymentMethod
public Syspay_Merchant_Entity_BillingAgreement
# setPaymentMethod( Syspay_Merchant_Entity_PaymentMethod $payment_method )

Sets the value of payment_method.

Sets the value of payment_method.

Parameters

$payment_method
the payment_method

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public DateTime
# getExpirationDate( )

Gets the value of expirationDate.

Gets the value of expirationDate.

Returns

DateTime
DateTime
public Syspay_Merchant_Entity_BillingAgreement
# setExpirationDate( DateTime $expirationDate )

Sets the value of expirationDate.

Sets the value of expirationDate.

Parameters

$expirationDate
the expirationDate

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public string
# getRedirect( )

Gets the value of redirect.

Gets the value of redirect.

Returns

string
string
public Syspay_Merchant_Entity_BillingAgreement
# setRedirect( string $redirect )

Sets the value of redirect.

Sets the value of redirect.

Parameters

$redirect
the redirect

Returns

Syspay_Merchant_Entity_BillingAgreement
self
public string
# getDescription( )

Gets the value of description.

Gets the value of description.

Returns

string
string
public Syspay_Merchant_Entity_BillingAgreement
# setDescription( string $description )

Sets the value of description.

Sets the value of description.

Parameters

$description
the description

Returns

Syspay_Merchant_Entity_BillingAgreement
self
Methods inherited from Syspay_Merchant_Entity
getType(), toArray()
Constants summary
string TYPE
#'billing_agreement'
string STATUS_PENDING
#'PENDING'
string STATUS_ACTIVE
#'ACTIVE'
string STATUS_CANCELLED
#'CANCELLED'
string STATUS_ENDED
#'ENDED'
string END_REASON_UNSUBSCRIBED_MERCHANT
#'UNSUBSCRIBED_MERCHANT'
string END_REASON_UNSUBSCRIBED_ADMIN
#'UNSUBSCRIBED_ADMIN'
string END_REASON_SUSPENDED_EXPIRED
#'SUSPENDED_EXPIRED'
string END_REASON_SUSPENDED_CHARGEBACK
#'SUSPENDED_CHARGEBACK'
Properties inherited from Syspay_Merchant_Entity
$raw
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0