Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • VivaPayments
      • Message
  • PHP

Classes

  • AbstractRestRequest
  • FetchTransactionsRequest
  • NativeAuthorizeRequest
  • NativePurchaseRequest
  • RedirectAuthorizeRequest
  • RedirectPurchaseRequest
  • RedirectResponse
  • RefundRequest
  • RestResponse
  • Overview
  • Namespace
  • Class
  • Tree

Class FetchTransactionsRequest

Viva Payments (REST) Fetch Transactions Request

This method allows you to obtain:

  • Details for all transactions for a given Payment Order.
  • A list of all transactions that occurred on a given day.

Example

Possible parameters are:

  • date -- the date on which the transaction was made.
  • clearanceDate -- the date on which the transaction was cleared.
  • transactionReference -- the ID of a transaction, as returned by the GET parameter when redirecting a customer back to your site. This will be a 36 character UUID.
  • transactionId -- the Order Code which will be the 12 or 16 digit code returned from a purchase() request.
$transaction = $gateway->fetchTransactions(array(
    'transactionReference'  => $transaction_id,
));
$response = $transaction->send();
if ($response->isSuccessful()) {
    $transactionList = $response->getData();
} else {
    echo "Fetch transactions failed.\n";
    echo "Error code == " . $response->getCode() . "\n";
    echo "Error message == " . $response->getMessage() . "\n";
}
Omnipay\Common\Message\AbstractRequest implements Omnipay\Common\Message\RequestInterface
Extended by Omnipay\VivaPayments\Message\AbstractRestRequest
Extended by Omnipay\VivaPayments\Message\FetchTransactionsRequest
Namespace: Omnipay\VivaPayments\Message
See: Omnipay\VivaPayments\RestGateway
Link: https://github.com/VivaPayments/API/wiki
Link: https://www.vivawallet.com/en-us/company
Link: https://github.com/VivaPayments/API/wiki/GetTransactions
Located at Message/FetchTransactionsRequest.php
Methods summary
public string
# getDate( )

Get the transaction date.

Get the transaction date.

YYYY-MM-DD format appears to be used by the gateway.

Returns

string
public Omnipay\VivaPayments\Message\AbstractRestRequest
# setDate( string $value )

Set the transaction date.

Set the transaction date.

YYYY-MM-DD format appears to be used by the gateway.

Parameters

$value

Returns

Omnipay\VivaPayments\Message\AbstractRestRequest
provides a fluent interface.
public string
# getClearanceDate( )

Get the transaction clearance date.

Get the transaction clearance date.

YYYY-MM-DD format appears to be used by the gateway.

Returns

string
public Omnipay\VivaPayments\Message\AbstractRestRequest
# setClearanceDate( string $value )

Set the transaction clearance date.

Set the transaction clearance date.

YYYY-MM-DD format appears to be used by the gateway.

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

Overrides

Omnipay\VivaPayments\Message\AbstractRestRequest::getData()
protected string
# getHttpMethod( )

Get HTTP Method.

Get HTTP Method.

This is nearly always POST but can be over-ridden in sub classes.

Returns

string

Overrides

Omnipay\VivaPayments\Message\AbstractRestRequest::getHttpMethod()
protected string
# getEndpoint( )

Get transaction endpoint.

Get transaction endpoint.

Purchases are created using the /purchases resource.

Returns

string

Overrides

Omnipay\VivaPayments\Message\AbstractRestRequest::getEndpoint()
Methods inherited from Omnipay\VivaPayments\Message\AbstractRestRequest
createResponse(), getApiKey(), getBaseEndpoint(), getMerchantId(), getRequestLang(), getSourceCode(), sendData(), setApiKey(), setMerchantId(), setRequestLang(), setSourceCode()
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 inherited from Omnipay\VivaPayments\Message\AbstractRestRequest
$liveEndpoint, $testEndpoint
Properties inherited from Omnipay\Common\Message\AbstractRequest
$httpClient, $httpRequest, $negativeAmountAllowed, $parameters, $response, $zeroAmountAllowed
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen