README

Sipay, is a payment gateway that provides a secure and easy-to-use payment infrastructure.

This package is a PHP SDK for the Sipay API.

Important: This package is still in development. Please use it with caution and report any issues you encounter.

Requirements

PHP 7.4+
ext-curl, ext-json, ext-openssl extensions

Installation

Run the following command under your project to install the package via Composer

composer require sipay-tr/sipay-php-sdk

Getting Started

You can create a new instance of the Sipay class by passing the required parameters to the constructor. You can find the required parameters in the sample code below.

$sipayOptions = new \Sipay\SipayOptions(
    '<API KEY>',
    '<API SECRET>',
    '<MERCHANT KEY>',
    '<MERCHANT ID>',
    'https://app.sipay.com.tr/ccpayment'
);
$sipay = new Sipay($sipayOptions);

Note: For Test API server and credentials, you can check the Sipay API Documentation

Examples

Included in the project are a number of examples that cover almost all use-cases. Refer to the samples folder for more info.

Card Holder IP Address

Card payments (NonSecurePaymentInvoice, SecurePaymentInvoice and SavedCardPaymentInvoice) accept the IP address of the card holder, i.e. the end user making the payment, not your server's IP. Set it with setIp() and it is sent to the API as the ip field.

$paymentInvoice
    // ...
    ->setIp('203.0.113.10');

Format: a single valid IPv4 or IPv6 address, the same rule the API applies (values it rejects fail with Cardholder IP is invalid.). setIp() checks this up front and throws Sipay\Exceptions\InvalidArgumentException for anything else, such as an empty string or a comma-separated list. An IPv4-mapped IPv6 address (::ffff:203.0.113.7) is converted to plain IPv4.
Required or optional: optional in the SDK. The API requires it only when the "Cardholder IP" field is marked mandatory in your merchant billing settings; payments without it are then rejected with Cardholder IP is required.

Note: Behind a load balancer or reverse proxy, REMOTE_ADDR is the proxy's address. Use your framework's client IP helper with trusted proxies configured (e.g. Symfony Request::getClientIp(), Laravel $request->ip()). Don't pass the raw X-Forwarded-For header: it can contain several addresses, and the client controls it unless your own proxy overwrites it.

Testing

You can run the tests as following command below:

./vendor/bin/phpunit

To run a test file, you can use the following example command:

.vendor/bin/phpunit tests/Sipay/Resources/TokenTest.php

To run a test method in test file, you can use the following example command:

./vendor/bin/phpunit --filter testRetrieveWithSuccessfulResponse tests/Sipay/Resources/CardListTest.php

Releasing

Releases are created with the Release workflow (Actions → Release → Run workflow):

Pick a patch, minor or major bump; the next vX.Y.Z tag is computed from the latest stable tag.
CI (code style + tests on all supported PHP versions) must pass before the tag and GitHub release are created.
Release notes are generated automatically since the previous stable release; anything entered in notes is prepended to them.
Enable dry_run to see the computed version and run CI without tagging or releasing.

Stable releases can only be created from main. To test a version before releasing it, enable prerelease: this creates a release candidate such as v1.1.0-rc.1 (then rc.2, ...), and can be run from any branch that contains this workflow and every stable release (merge main into it first). Release candidates are marked as pre-releases on GitHub and are not installed by default on Packagist; install one explicitly:

composer require sipay-tr/sipay-php-sdk:1.1.0-rc.1

sipay-tr / sipay-php-sdk

Package info

Security

Statistics