https://github.com/sumup/sumup-ecom-php-sdk

PHP SDK for the SumUp API.
https://github.com/sumup/sumup-ecom-php-sdk

php sdk sumup

Last synced: about 1 year ago
JSON representation

PHP SDK for the SumUp API.

• Host: GitHub
• URL: https://github.com/sumup/sumup-ecom-php-sdk
• Owner: sumup
• License: apache-2.0
• Created: 2018-10-15T12:39:07.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-04-10T10:41:21.000Z (about 1 year ago)
• Last Synced: 2025-04-13T05:00:07.382Z (about 1 year ago)
• Topics: php, sdk, sumup
• Language: PHP
• Homepage: https://developer.sumup.com
• Size: 68.4 KB
• Stars: 47
• Watchers: 12
• Forks: 23
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


# SumUp Ecommerce PHP SDK

[![Stars](https://img.shields.io/github/stars/sumup/sumup-ecom-php-sdk?style=social)](https://github.com/sumup/sumup-go/)

[![Latest Stable Version](https://poser.pugx.org/sumup/sumup-ecom-php-sdk/v/stable.svg)](https://packagist.org/packages/sumup/sumup-ecom-php-sdk)

[![Total Downloads](https://poser.pugx.org/sumup/sumup-ecom-php-sdk/downloads.svg)](https://packagist.org/packages/sumup/sumup-ecom-php-sdk)

[![License](https://img.shields.io/github/license/sumup/sumup-go)](./LICENSE)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://github.com/sumup/sumup-go/tree/main/CODE_OF_CONDUCT.md)



## Overview

This repository contains the open source PHP SDK that allows you to integrate quickly with the SumUp's [API](https://developer.sumup.com/rest-api) endpoints.

## Installation

The SumUp eCom PHP SDK can be installed with [Composer](https://getcomposer.org/). Run the following command:

```

composer require sumup/sumup-ecom-php-sdk

```

## Basic usage

```php

try {

    $sumup = new \SumUp\SumUp([

        'app_id'     => 'YOUR-CLIENT-ID',

        'app_secret' => 'YOUR-CLIENT-SECRET',

        'code'       => 'YOUR-AUTHORIZATION-CODE'

    ]);

    $checkoutService = $sumup->getCheckoutService();

    $checkoutResponse = $checkoutService->create($amount, $currency, $checkoutRef, $payToEmail);

    $checkoutId = $checkoutResponse->getBody()->id;

//  pass the $chekoutId to the front-end to be processed

} catch (\SumUp\Exceptions\SumUpAuthenticationException $e) {

    echo 'Authentication error: ' . $e->getMessage();

} catch (\SumUp\Exceptions\SumUpResponseException $e) {

    echo 'Response error: ' . $e->getMessage();

} catch(\SumUp\Exceptions\SumUpSDKException $e) {

    echo 'SumUp SDK error: ' . $e->getMessage();

}

```

## API Reference

For a full list of classes, see the [API reference page](https://github.com/sumup/sumup-ecom-php-sdk/tree/master/docs).

## FAQ

* [How to authorize?](https://github.com/sumup/sumup-ecom-php-sdk/blob/master/docs/HowToAuthorize.md)

* [How to handle exceptions?](https://github.com/sumup/sumup-ecom-php-sdk/blob/master/docs/ExceptionsHandling.md)

* [How to use my own HTTP client?](https://github.com/sumup/sumup-ecom-php-sdk/blob/master/docs/HowToOverrideHttpClient.md)

## Roadmap

| Version | Status | PHP Version |

|--- |--- |--- |

| 1.x | Latest | \>= 5.6 |

## License

For information about the license see the [license](https://github.com/sumup/sumup-ecom-php-sdk/blob/master/LICENSE.md) file.

## Contact us

If you have found a bug or you lack some functionality please [open an issue](https://github.com/sumup/sumup-ecom-php-sdk/issues/new). If you have other issues when integrating with SumUp's API you can send an email to [integration@sumup.com](mailto:integration@sumup.com).