# PAY.JP for PHP

[![Build Status](https://github.com/payjp/payjp-php/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/payjp/payjp-php/actions)

## Requirements

PHP 5.6 and later.

> Even if it is not a corresponding version, it may work, but it does not support it.
  Due to the PHP [END OF LIFE](http://php.net/supported-versions.php) cycle.

## Composer

You can install the bindings via [Composer](http://getcomposer.org/). Add this to your `composer.json`:

    {
      "require": {
        "payjp/payjp-php": "~1.0"
      }
    }

Then install via:

    composer install

To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):

    require_once 'vendor/autoload.php';

## Manual Installation

If you do not wish to use Composer, you can download the [latest release](https://github.com/payjp/payjp-php/releases). Then, to use the bindings, include the `init.php` file.

    require_once '/path/to/payjp-php/init.php';

## Getting Started

In advance, you need to get a token by [Checkout](https://pay.jp/docs/checkout) or [payjp.js](https://pay.jp/docs/payjs).

```php
\Payjp\Payjp::setApiKey('sk_test_c62fade9d045b54cd76d7036');
$charge = \Payjp\Charge::create(array(
  'card' => 'token_id_by_Checkout_or_payjp-js',
  'amount' => 2000,
  'currency' => 'jpy'
));
echo $charge->amount; // 2000
```

## Documentation

- [Request Example](https://github.com/payjp/payjp-php/blob/master/RequestExample.md)
- Please see our official [documentation](https://pay.jp/docs/started).

## Retry on HTTP Status Code 429

- See [Rate Limit Guideline](https://pay.jp/docs/guideline-rate-limit#2-%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4)
- When you exceeded rate-limit, you can retry request by setting `$maxRetry`
  like `\Payjp\Payjp::setMaxRetry(3);` .
- The retry interval base value is `$retryInitialDelay`
  Adjust the value like `\Payjp\Payjp::setRetryInitialDelay(4);`
  The smaller is shorter.
- The retry interval calcurating is based on "Exponential backoff with equal jitter" algorithm.
  See https://aws.amazon.com/jp/blogs/architecture/exponential-backoff-and-jitter/

## Logging

- This library provides simple log output using `error_log` . You can set any logger that is compatible [PSR-3](https://www.php-fig.org/psr/psr-3/) logger interface. Like below
- `\Payjp\Payjp::setLogger($logger);`
- As the default behavior, this library output only error level information to stderr.

### Logging Case
#### info

- Every retry on HTTP Status Code 429

#### error

- When you access inaccessible or non-existing property

## Development

### Running Tests

In order to run tests first install [PHPUnit](http://packagist.org/packages/phpunit/phpunit) via [Composer](http://getcomposer.org/):

    composer update --dev

To run the test suite:

    ./vendor/bin/phpunit

You can also use Composer to run the tests:

    composer test

This will run both the code style checks (PSR2) and the PHPUnit tests.

### Code Formatting

To format the code according to our standards:

    composer fix

This command requires PHP 7.4 or higher and will automatically fix coding style issues using PHP-CS-Fixer.