Class AbstractRestRequest

Viva Payments Abstract REST Request

This is the parent class for all Viva Payments REST requests.

Omnipay\Common\Message\AbstractRequest implements Omnipay\Common\Message\RequestInterface

Omnipay\VivaPayments\Message\AbstractRestRequest

Direct known subclasses

Omnipay\VivaPayments\Message\FetchTransactionsRequest, Omnipay\VivaPayments\Message\NativePurchaseRequest, Omnipay\VivaPayments\Message\RedirectPurchaseRequest, Omnipay\VivaPayments\Message\RefundRequest

Indirect known subclasses

Omnipay\VivaPayments\Message\NativeAuthorizeRequest, Omnipay\VivaPayments\Message\RedirectAuthorizeRequest

Abstract
Namespace: Omnipay\VivaPayments\Message
See: Omnipay\VivaPayments\RestGateway
Link: http://www.paystream.com.au/developer-guides/
Located at Message/AbstractRestRequest.php

Methods summary
`protected string`	# `getHttpMethod( )` Get HTTP Method. Get HTTP Method. This is nearly always POST but can be over-ridden in sub classes. Returns string
`protected string`	# `getBaseEndpoint( )` Get base endpoint URL Get base endpoint URL Returns string
`protected string`	# `getEndpoint( )` Get API endpoint URL Get API endpoint URL Returns string
`public string`	# `getMerchantId( )` Get the gateway merchantId Get the gateway merchantId Returns string
`public Omnipay\VivaPayments\Message\AbstractRestRequest`	# `setMerchantId( string $value )` Set the gateway merchantId Set the gateway merchantId Note that all test merchantIds begin with the word TEST in upper case. Parameters `$value` Returns `Omnipay\VivaPayments\Message\AbstractRestRequest` provides a fluent interface.
`public string`	# `getApiKey( )` Get the gateway apiKey -- used as the password in HTTP Basic Auth Get the gateway apiKey -- used as the password in HTTP Basic Auth Returns string
`public Omnipay\VivaPayments\Message\AbstractRestRequest`	# `setApiKey( string $value )` Set the gateway apiKey -- used as the password in HTTP Basic Auth Set the gateway apiKey -- used as the password in HTTP Basic Auth Parameters `$value` Returns `Omnipay\VivaPayments\Message\AbstractRestRequest` provides a fluent interface.
`public string`	# `getRequestLang( )` Get the gateway language Get the gateway language The language (in ISO format) that the payment form is displayed. This parameter is also included in the target URL the application uses to redirect the user after the successful/unsuccessful completion of a payment. Note: If no parameter is passed, the system assumes el-GR. The payment form is currently displayed in the English language for all values other than el-GR. Returns string
`public Omnipay\VivaPayments\Message\AbstractRestRequest`	# `setRequestLang( string $value )` Set the gateway language Set the gateway language The language (in ISO format) that the payment form is displayed. This parameter is also included in the target URL the application uses to redirect the user after the successful/unsuccessful completion of a payment. Note: If no parameter is passed, the system assumes el-GR. The payment form is currently displayed in the English language for all values other than el-GR. Parameters `$value` Returns `Omnipay\VivaPayments\Message\AbstractRestRequest` provides a fluent interface.
`public string`	# `getSourceCode( )` Get the transaction source code. Get the transaction source code. Sources can be created and managed from the merchant's profile. A source is used for grouping and filtering transactions (ie a merchant may have more than one websites, or different product categories). Note: SourceCode is case-sensitive. Returns string
`public Omnipay\VivaPayments\Message\AbstractRestRequest`	# `setSourceCode( string $value )` Set the transaction source code. Set the transaction source code. Sources can be created and managed from the merchant's profile. A source is used for grouping and filtering transactions (ie a merchant may have more than one websites, or different product categories). Note: SourceCode is case-sensitive. Parameters `$value` Returns `Omnipay\VivaPayments\Message\AbstractRestRequest` provides a fluent interface.
`public mixed`	# `getData( )` Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement. Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement. Returns mixed
`protected Omnipay\VivaPayments\Message\RestResponse`	# `createResponse( Omnipay\Common\Message\RequestInterface $request, $data, integer $statusCode = 200 )` Creates the correct type of response for this request. Creates the correct type of response for this request. This is a hook to allow different types of request to create their own response types, normally used when there is a redirect request of some kind. Parameters `$request` `$data` `$statusCode` Returns `Omnipay\VivaPayments\Message\RestResponse`
`public ResponseInterface`	# `sendData( mixed $data )` Send the request with specified data Send the request with specified data Parameters `$data` The data to send Returns ResponseInterface

Methods inherited from Omnipay\Common\Message\AbstractRequest
__construct(), formatCurrency(), getAmount(), getAmountInteger(), getCancelUrl(), getCard(), getCardReference(), getClientIp(), getCurrency(), getCurrencyDecimalPlaces(), getCurrencyNumeric(), getDescription(), getIssuer(), getItems(), getNotifyUrl(), getParameter(), getParameters(), getPaymentMethod(), getResponse(), getReturnUrl(), getTestMode(), getToken(), getTransactionId(), getTransactionReference(), initialize(), send(), setAmount(), setCancelUrl(), setCard(), setCardReference(), setClientIp(), setCurrency(), setDescription(), setIssuer(), setItems(), setNotifyUrl(), setParameter(), setPaymentMethod(), setReturnUrl(), setTestMode(), setToken(), setTransactionId(), setTransactionReference(), toFloat(), validate()

Properties summary
`protected string`	`$testEndpoint` Sandbox Endpoint URL Sandbox Endpoint URL	# `'http://demo.vivapayments.com'`
`protected string`	`$liveEndpoint` Live Endpoint URL Live Endpoint URL	# `'https://www.vivapayments.com'`

Properties inherited from Omnipay\Common\Message\AbstractRequest
`$httpClient, $httpRequest, $negativeAmountAllowed, $parameters, $response, $zeroAmountAllowed`

Namespaces

Classes

Class AbstractRestRequest

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns