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_RebillRequest

Rebill a customer

Syspay_Merchant_Request
Extended by Syspay_Merchant_RebillRequest
See: https://app.syspay.com/bundles/emiuser/doc/merchant_api.html#issue-a-rebill-on-a-billing-agreement
Located at Syspay/SDK/Merchant/Request/Rebill.php
Methods summary
public
# __construct( mixed $billingAgreementId = null )
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 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()
public string
# getThreatMetrixSessionId( )

Gets the value of threatMetrixSessionId.

Gets the value of threatMetrixSessionId.

Returns

string
string
public Syspay_Merchant_RebillRequest
# setThreatMetrixSessionId( string $threatMetrixSessionId )

Sets the value of threatMetrixSessionId.

Sets the value of threatMetrixSessionId.

Parameters

$threatMetrixSessionId
the threatMetrixSessionId

Returns

Syspay_Merchant_RebillRequest
self
public string
# getEmsUrl( )

Gets the value of emsUrl.

Gets the value of emsUrl.

Returns

string
string
public Syspay_Merchant_RebillRequest
# setEmsUrl( string $emsUrl )

Sets the value of emsUrl.

Sets the value of emsUrl.

Parameters

$emsUrl
the emsUrl

Returns

Syspay_Merchant_RebillRequest
self
public integer
# getBillingAgreementId( )

Gets the value of billingAgreementId.

Gets the value of billingAgreementId.

Returns

integer
integer
public Syspay_Merchant_RebillRequest
# setBillingAgreementId( integer $billingAgreementId )

Sets the value of billingAgreementId.

Sets the value of billingAgreementId.

Parameters

$billingAgreementId
the billingAgreementId

Returns

Syspay_Merchant_RebillRequest
self
public string
# getReference( )

Gets the value of reference.

Gets the value of reference.

Returns

string
string
public Syspay_Merchant_RebillRequest
# setReference( string $reference )

Sets the value of reference.

Sets the value of reference.

Parameters

$reference
the reference

Returns

Syspay_Merchant_RebillRequest
self
public integer
# getAmount( )

Gets the value of amount.

Gets the value of amount.

Returns

integer
integer
public Syspay_Merchant_RebillRequest
# setAmount( integer $amount )

Sets the value of amount.

Sets the value of amount.

Parameters

$amount
the amount

Returns

Syspay_Merchant_RebillRequest
self
public string
# getCurrency( )

Gets the value of currency.

Gets the value of currency.

Returns

string
string
public Syspay_Merchant_RebillRequest
# setCurrency( string $currency )

Sets the value of currency.

Sets the value of currency.

Parameters

$currency
the currency

Returns

Syspay_Merchant_RebillRequest
self
public string
# getDescription( )

Gets the value of description.

Gets the value of description.

Returns

string
string
public Syspay_Merchant_RebillRequest
# setDescription( string $description )

Sets the value of description.

Sets the value of description.

Parameters

$description
the description

Returns

Syspay_Merchant_RebillRequest
self
public string
# getExtra( )

Gets the value of extra.

Gets the value of extra.

Returns

string
string
public Syspay_Merchant_RebillRequest
# setExtra( string $extra )

Sets the value of extra.

Sets the value of extra.

Parameters

$extra
the extra

Returns

Syspay_Merchant_RebillRequest
self
public array
# getRecipientMap( )

Gets the value of recipient_map.

Gets the value of recipient_map.

Returns

array
array
public Syspay_Merchant_RebillRequest
# setRecipientMap( array $recipientMap )

Sets the value of recipient_map.

Sets the value of recipient_map.

Parameters

$recipientMap
An array of Syspay_Merchant_Entity_PaymentRecipient

Returns

Syspay_Merchant_RebillRequest
self
public Syspay_Merchant_RebillRequest
# addRecipient( Syspay_Merchant_Entity_PaymentRecipient $paymentRecipient )

Add a PaymentRecipient to the recipient map list

Add a PaymentRecipient to the recipient map list

Parameters

$paymentRecipient

Returns

Syspay_Merchant_RebillRequest
self
Constants summary
string METHOD
#'POST'
string PATH
#'/api/v1/merchant/billing-agreement/%d/rebill'
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0