|
| 1 | +# A Laravel package to Toss Payments |
| 2 | + |
| 3 | + |
| 4 | +[](https://packagist.org/packages/getsolaris/laravel-tosspayments) |
| 5 | +[](https://github.com/getsolaris/laravel-tosspayments/actions?query=workflow%3Arun-tests+branch%3Amain) |
| 6 | +[](https://github.com/getsolaris/laravel-tosspayments/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) |
| 7 | +[](https://packagist.org/packages/getsolaris/laravel-tosspayments) |
| 8 | + |
| 9 | + |
| 10 | +토스페이먼츠 (Toss Payments) 라라벨 API 입니다. |
| 11 | + |
| 12 | +# 설치 |
| 13 | +```bash |
| 14 | +composer require getsolaris/laravel-tosspayments |
| 15 | +``` |
| 16 | + |
| 17 | +`.env` 에 아래의 환경변수가 추가되어야 합니다. |
| 18 | +Toss Payments 개발자센터에서 발급받은 클라이언트 키와 시크릿 키를 환경변수에 추가합니다. |
| 19 | + |
| 20 | +```bash |
| 21 | +TOSS_PAYMENTS_CLIENT_KEY= |
| 22 | +TOSS_PAYMENTS_SECRET_KEY= |
| 23 | +``` |
| 24 | + |
| 25 | +`config` 파일을 생성하기 위해서 아래 명령어를 수행합니다. |
| 26 | + |
| 27 | +```bash |
| 28 | +php artisan vendor:publish --provider="Getsolaris\LaravelTossPayments\TossPaymentsServiceProvider" --tag="config" |
| 29 | +``` |
| 30 | + |
| 31 | +# 사용 |
| 32 | + |
| 33 | +Toss Payments 개발자센터의 [코어 API](https://docs.tosspayments.com/reference) 를 참고합니다. |
| 34 | + |
| 35 | +API 를 사용하기 앞서 인증을 위한 API 키 준비와 인증 관련된 문서는 [해당 페이지](https://docs.tosspayments.com/guides/using-api)에서 확인 가능합니다. |
| 36 | + |
| 37 | +Basic 인증 방식은 `{SECRET_KEY}:` 를 Base64 인코딩 한 값을 사용합니다. |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +## [결제 (Payment)](https://docs.tosspayments.com/reference#%EA%B2%B0%EC%A0%9C) |
| 42 | + |
| 43 | +### [결제승인](https://docs.tosspayments.com/reference#%EA%B2%B0%EC%A0%9C-%EC%8A%B9%EC%9D%B8) |
| 44 | + |
| 45 | +POST /v1/payments/confirm |
| 46 | + |
| 47 | +```php |
| 48 | +use Getsolaris\LaravelTossPayments\TossPayments; |
| 49 | +use Getsolaris\LaravelTossPayments\Attributes\Payment; |
| 50 | + |
| 51 | +$payment = TossPayments::for(Payment::class) |
| 52 | + ->paymentKey($paymentKey) |
| 53 | + ->orderId($orderId) |
| 54 | + ->amount($amount) |
| 55 | + ->confirm(); |
| 56 | + |
| 57 | +return $payment->json(); |
| 58 | +``` |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +## [거래 (Transaction)](https://docs.tosspayments.com/reference#%EA%B1%B0%EB%9E%98) |
| 63 | + |
| 64 | +### [거래 조회](https://docs.tosspayments.com/reference#%EA%B1%B0%EB%9E%98-%EC%A1%B0%ED%9A%8C) |
| 65 | + |
| 66 | +GET /v1/transactions |
| 67 | + |
| 68 | +```php |
| 69 | +use Getsolaris\LaravelTossPayments\TossPayments; |
| 70 | +use Getsolaris\LaravelTossPayments\Attributes\Transaction; |
| 71 | + |
| 72 | +$transactions = TossPayments::for(Transaction::class) |
| 73 | + ->startDate('2022-01-01') |
| 74 | + ->endDate('2022-12-31') |
| 75 | + ->get(); |
| 76 | + |
| 77 | +return $transactions->json(); |
| 78 | +``` |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +## [테스트 코드 사용하기](https://docs.tosspayments.com/reference/error-codes#%EC%97%90%EB%9F%AC-%EC%BD%94%EB%93%9C) |
| 83 | + |
| 84 | +[에러코드](https://docs.tosspayments.com/reference/error-codes#%EC%97%90%EB%9F%AC-%EC%BD%94%EB%93%9C)를 확인하여 |
| 85 | +특정 에러가 발생했을 때와 같이 예상된 시나리오를 직접 발생시켜 처리해 볼 수 있습니다. |
| 86 | + |
| 87 | +```php |
| 88 | +use Getsolaris\LaravelTossPayments\TossPayments; |
| 89 | +use Getsolaris\LaravelTossPayments\Attributes\Transaction; |
| 90 | + |
| 91 | +$transactions = TossPayments::for(Transaction::class) |
| 92 | + ->startDate('2022-01-01T00:00:00') |
| 93 | + ->endDate('2022-12-31T00:00:00') |
| 94 | + ->testCode('INVALID_CARD_EXPIRATION') |
| 95 | + ->get(); |
| 96 | +``` |
| 97 | + |
| 98 | + |
| 99 | +## Resource |
| 100 | +- [Toss Payments 개발자센터](https://developers.tosspayments.com/) |
| 101 | +- [Toss Payments 코어 API](https://docs.tosspayments.com/reference) |
| 102 | + |
| 103 | +## Changelog |
| 104 | + |
| 105 | +Please see [CHANGELOG](../CHANGELOG.md) for more information on what has changed recently. |
| 106 | + |
| 107 | +## License |
| 108 | + |
| 109 | +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
0 commit comments