Transactions service for the SumUp Ecommerce SDK for PHP

\SumUp\Services\Transactions

The \SumUp\Services\Transactions service is responsible for managing transactions: getting transactions, getting transactions history, making refunds, getting receipts.

$transactionService = new \SumUp\Services\Transactions(
    \SumUp\HttpClients\SumUpHttpClientInterface $client,
    \SumUp\Authentication\AccessToken $accessToken
);

Instance Methods

findById()

Searches for a transaction by id.

public function findById(string $transactionId): \SumUp\HttpClients\Response

Returns a \SumUp\HttpClients\Response or throws an exception.

findByInternalId()

Searches for a transaction by internal_id.

public function findByInternalId(string $internalId): \SumUp\HttpClients\Response

Returns a \SumUp\HttpClients\Response or throws an exception.

findByForeignId()

Searches for a transaction by foreign transaction id.

public function findByForeignId(string $foreignId): \SumUp\HttpClients\Response

Returns a \SumUp\HttpClients\Response or throws an exception.

findByTransactionCode()

Searches for a transaction by transaction_code.

public function findByTransactionCode(string $transactionCode): \SumUp\HttpClients\Response

Returns a \SumUp\HttpClients\Response or throws an exception.

getTransactionHistory()

Returns a list of all transactions according to the provided filter.

public function getTransactionHistory(array $filters = []): \SumUp\HttpClients\Response

Available filters are:

Note: for more information about the filters read the API documentation.

Returns a \SumUp\HttpClients\Response or throws an exception.

refund()

Refunds a transaction partially or fully depending on the amount.

public function refund(string $transactionId, float $amount = null): \SumUp\HttpClients\Response

Returns a \SumUp\HttpClients\Response or throws an exception.

getReceipt()

Returns receipt data about a transaction.

public function getReceipt(string $transactionId, string $merchantId): \SumUp\HttpClients\Response

Returns a \SumUp\HttpClients\Response or throws an exception.