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_Client

Base API client

See: https://app.syspay.com/bundles/emiuser/doc/merchant_api.html#emerchant-rest-api
Located at Syspay/SDK/Merchant/Client.php
Methods summary
public
# __construct( string $username, string $secret, string $baseUrl = null )

Creates a new client object

Creates a new client object

Parameters

$username
The Syspay API username
$secret
The Syspay API shared secret
$baseUrl
The base URL the request should be made to (optional, defaults to prod environment)
public mixed
# request( Syspay_Merchant_Request $request )

Make a request to the Syspay API

Make a request to the Syspay API

Parameters

$request
The request to send to the API

Returns

mixed
The response to the request

Throws

Syspay_Merchant_RequestException
If the request could not be processed by the API
public string
# getResponseBody( )

Get the raw body of the last request.

Get the raw body of the last request.

Returns

string
The last request's response body, or null if the request failed.
public array
# getResponseHeaders( )

Get the raw headers of the last request.

Get the raw headers of the last request.

Returns

array
The last request's headers, or an empty array if the request failed
public string
# getUsername( )

Get the username

Get the username

Returns

string
Merchant username
public string
# getSecret( )

Get the shared secret

Get the shared secret

Returns

string
secret
public string
# getBaseUrl( )

Get the base URL

Get the base URL

Returns

string
Base URL
public mixed
# getResponseData( )

Get the (decoded) response data, if available

Get the (decoded) response data, if available

Returns

mixed
Response data
public array
# getRequestHeaders( )

Get the request headers, if available

Get the request headers, if available

Returns

array
Request headers
public array
# getRequestBody( )

Get the request body, if available (POST/PUT requests)

Get the request body, if available (POST/PUT requests)

Returns

array
Request body
public array
# getRequestParams( )

Get the request params, if available (GET request)

Get the request params, if available (GET request)

Returns

array
Request body
public string
# getRequestId( )

Get the last request's id

Get the last request's id

Returns

string
Request Id or null if it couldn't be extracted
Constants summary
string BASE_URL_PROD
#'https://app.syspay.com'
string BASE_URL_SANDBOX
#'https://app-sandbox.syspay.com'
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0