Skip to content

Commit 3e98878

Browse files
getsolarisgetsolaris
authored
Merge pull request #3 from getsolaris/docs/example
Example
2 parents fa8c64e + 34dbbf3 commit 3e98878

File tree

7 files changed

+283
-263
lines changed

7 files changed

+283
-263
lines changed

‎README.md

Lines changed: 6 additions & 263 deletions
Original file line numberDiff line numberDiff line change
@@ -49,289 +49,32 @@ Basic 인증 방식은 `{SECRET_KEY}:` 를 Base64 인코딩 한 값을 사용합
4949

5050
## [결제 (Payment)](https://docs.tosspayments.com/reference#%EA%B2%B0%EC%A0%9C)
5151

52-
### [결제승인](https://docs.tosspayments.com/reference#%EA%B2%B0%EC%A0%9C-%EC%8A%B9%EC%9D%B8)
52+
[예제 보기](examples/PAYMENT.md)
5353

54-
POST /v1/payments/confirm
55-
56-
```php
57-
use Getsolaris\LaravelTossPayments\TossPayments;
58-
use Getsolaris\LaravelTossPayments\Attributes\Payment;
59-
60-
$payment = TossPayments::for(Payment::class)
61-
->paymentKey($paymentKey)
62-
->orderId($orderId)
63-
->amount($amount)
64-
->confirm();
65-
66-
return $payment->json();
67-
```
68-
69-
### [paymentKey로 결제 조회](https://docs.tosspayments.com/reference#paymentkey%EB%A1%9C-%EA%B2%B0%EC%A0%9C-%EC%A1%B0%ED%9A%8C)
70-
71-
GET /v1/payments/{paymentKey}
72-
73-
```php
74-
use Getsolaris\LaravelTossPayments\TossPayments;
75-
use Getsolaris\LaravelTossPayments\Attributes\Payment;
76-
77-
$payment = TossPayments::for(Payment::class)
78-
->paymentKey($paymentKey)
79-
->get();
80-
81-
return $payment->json();
82-
```
83-
84-
### [orderId로 결제 조회](https://docs.tosspayments.com/reference#orderid%EB%A1%9C-%EA%B2%B0%EC%A0%9C-%EC%A1%B0%ED%9A%8C)
85-
86-
GET /v1/payments/orders/{orderId}
87-
88-
```php
89-
use Getsolaris\LaravelTossPayments\TossPayments;
90-
use Getsolaris\LaravelTossPayments\Attributes\Payment;
91-
92-
$payment = TossPayments::for(Payment::class)
93-
->orderId($orderId)
94-
->get();
95-
96-
return $payment->json();
97-
```
98-
99-
### [결제 취소](https://docs.tosspayments.com/reference#%EA%B2%B0%EC%A0%9C-%EC%B7%A8%EC%86%8C)
100-
101-
POST /v1/payments/{paymentKey}/cancel
102-
103-
```php
104-
use Getsolaris\LaravelTossPayments\TossPayments;
105-
use Getsolaris\LaravelTossPayments\Attributes\Payment;
106-
107-
$payment = TossPayments::for(Payment::class)
108-
->paymentKey($paymentKey)
109-
->cancelReason('고객 변심')
110-
->cancel(
111-
refundReceiveAccount: new RefundReceiveAccount(
112-
bank: '11',
113-
accountNumber: '111111111111',
114-
holderName: '홍길동'
115-
)
116-
);
117-
118-
return $payment->json();
119-
```
120-
121-
### [카드 번호 결제](https://docs.tosspayments.com/reference#%EC%B9%B4%EB%93%9C-%EB%B2%88%ED%98%B8-%EA%B2%B0%EC%A0%9C)
122-
123-
POST /v1/payments/key-in
124-
125-
```php
126-
use Getsolaris\LaravelTossPayments\TossPayments;
127-
use Getsolaris\LaravelTossPayments\Attributes\Payment;
128-
129-
$keyIn = TossPayments::for(Payment::class)
130-
->amount($amount)
131-
->orderId($orderId)
132-
->orderName($orderName)
133-
->cardNumber($cardNumber)
134-
->cardExpirationYear($cardExpirationYear)
135-
->cardExpirationMonth($cardExpirationMonth)
136-
->customerIdentityNumber($customerIdentityNumber)
137-
->keyIn();
138-
139-
return $keyIn->json();
140-
```
141-
142-
143-
### [가상계좌 발급 요청](https://docs.tosspayments.com/reference#%EA%B0%80%EC%83%81%EA%B3%84%EC%A2%8C-%EB%B0%9C%EA%B8%89-%EC%9A%94%EC%B2%AD)
144-
145-
POST /v1/virtual-accounts
146-
147-
```php
148-
use Getsolaris\LaravelTossPayments\TossPayments;
149-
use Getsolaris\LaravelTossPayments\Attributes\Payment;
150-
151-
$virtualAccounts = TossPayments::for(Payment::class)
152-
->amount($amount)
153-
->orderId($orderId)
154-
->orderName($orderName)
155-
->customerName($customerName)
156-
->bank('우리')
157-
->virtualAccounts();
158-
159-
return $virtualAccounts->json();
160-
```
16154

16255
## [거래 (Transaction)](https://docs.tosspayments.com/reference#%EA%B1%B0%EB%9E%98)
16356

164-
### [거래 조회](https://docs.tosspayments.com/reference#%EA%B1%B0%EB%9E%98-%EC%A1%B0%ED%9A%8C)
57+
[예제 보기](examples/TRANSACTION.md)
16558

166-
GET /v1/transactions
167-
168-
```php
169-
use Getsolaris\LaravelTossPayments\TossPayments;
170-
use Getsolaris\LaravelTossPayments\Attributes\Transaction;
171-
172-
$transactions = TossPayments::for(Transaction::class)
173-
->startDate('2022-01-01')
174-
->endDate('2022-12-31')
175-
->get();
176-
177-
return $transactions->json();
178-
```
17959

18060
## [자동 결제 (Billing)](https://docs.tosspayments.com/reference#%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C)
18161

182-
### [customerKey로 카드 자동 결제 빌링키 발급 요청](https://docs.tosspayments.com/reference#customerkey%EB%A1%9C-%EC%B9%B4%EB%93%9C-%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C-%EB%B9%8C%EB%A7%81%ED%82%A4-%EB%B0%9C%EA%B8%89-%EC%9A%94%EC%B2%AD)
62+
[예제 보기](examples/BILLING.md)
18363

184-
POST /v1/billing/authorizations/card
185-
186-
```php
187-
use Getsolaris\LaravelTossPayments\TossPayments;
188-
use Getsolaris\LaravelTossPayments\Attributes\Billing;
189-
190-
$billing = TossPayments::for(Billing::class)
191-
->customerKey($customerKey)
192-
->cardNumber($cardNumber)
193-
->cardExpirationYear($cardExpirationYear)
194-
->cardExpirationMonth($cardExpirationMonth)
195-
->customerIdentityNumber($customerIdentityNumber)
196-
->authorizationsCard();
197-
198-
return $billing->json();
199-
```
200-
201-
### [authKey로 카드 자동 결제 빌링키 발급 요청](https://docs.tosspayments.com/reference#authkey%EB%A1%9C-%EC%B9%B4%EB%93%9C-%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C-%EB%B9%8C%EB%A7%81%ED%82%A4-%EB%B0%9C%EA%B8%89-%EC%9A%94%EC%B2%AD)
202-
203-
POST /v1/billing/authorizations/issue
204-
205-
```php
206-
use Getsolaris\LaravelTossPayments\TossPayments;
207-
use Getsolaris\LaravelTossPayments\Attributes\Billing;
208-
209-
$billing = TossPayments::for(Billing::class)
210-
->customerKey($customerKey)
211-
->authKey($authKey)
212-
->authorizationsIssue();
213-
214-
return $billing->json();
215-
```
216-
217-
### [카드 자동 결제 승인 요청](https://docs.tosspayments.com/reference#%EC%B9%B4%EB%93%9C-%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C-%EC%8A%B9%EC%9D%B8-%EC%9A%94%EC%B2%AD)
218-
219-
POST /v1/billing/{billingKey}
220-
221-
```php
222-
use Getsolaris\LaravelTossPayments\TossPayments;
223-
use Getsolaris\LaravelTossPayments\Attributes\Billing;
224-
225-
$billing = TossPayments::for(Billing::class)
226-
->customerKey($customerKey)
227-
->authKey($authKey)
228-
->authorizationsIssue();
229-
230-
return $billing->json();
231-
```
23264

23365
## [정산 (Settlement)](https://docs.tosspayments.com/reference#%EC%A0%95%EC%82%B0)
23466

235-
### [정산 조회](https://docs.tosspayments.com/reference#%EC%A0%95%EC%82%B0-%EC%A1%B0%ED%9A%8C)
236-
237-
GET /v1/settlements
238-
239-
```php
240-
use Getsolaris\LaravelTossPayments\TossPayments;
241-
use Getsolaris\LaravelTossPayments\Attributes\Settlement;
242-
243-
$settlements = TossPayments::for(Settlement::class)
244-
->startDate($startDate)
245-
->endDate($endDate)
246-
->get();
247-
248-
return $settlements->json();
249-
```
250-
251-
### [수동 정산 요청](https://docs.tosspayments.com/reference#%EC%88%98%EB%8F%99-%EC%A0%95%EC%82%B0-%EC%9A%94%EC%B2%AD)
252-
253-
POST /v1/settlements
254-
255-
```php
256-
use Getsolaris\LaravelTossPayments\TossPayments;
257-
use Getsolaris\LaravelTossPayments\Attributes\Settlement;
258-
259-
$settlement = TossPayments::for(Settlement::class)
260-
->paymentKey($paymentKey)
261-
->request();
262-
263-
return $settlement->json();
264-
```
265-
67+
[예제 보기](examples/SETTLEMENT.md)
26668

26769

26870
## [현금영수증 (CashReceipt)](https://docs.tosspayments.com/reference#%ED%98%84%EA%B8%88%EC%98%81%EC%88%98%EC%A6%9D)
26971

270-
### [현금영수증 발급](https://docs.tosspayments.com/reference#%ED%98%84%EA%B8%88%EC%98%81%EC%88%98%EC%A6%9D)
271-
272-
POST /v1/cash-receipts
273-
274-
```php
275-
use Getsolaris\LaravelTossPayments\TossPayments;
276-
use Getsolaris\LaravelTossPayments\Attributes\CashReceipt;
277-
278-
$cashReceipt = TossPayments::for(CashReceipt::class)
279-
->amount($amount)
280-
->orderId($orderId)
281-
->orderName($orderName)
282-
->customerIdentityNumber($customerIdentityNumber)
283-
->type($type)
284-
->request();
285-
286-
return $cashReceipt->json();
287-
```
288-
289-
### [현금영수증 발급 취소](https://docs.tosspayments.com/reference#%ED%98%84%EA%B8%88%EC%98%81%EC%88%98%EC%A6%9D-%EB%B0%9C%EA%B8%89-%EC%B7%A8%EC%86%8C)
290-
291-
POST /v1/cash-receipts/{receiptKey}/cancel
292-
293-
```php
294-
use Getsolaris\LaravelTossPayments\TossPayments;
295-
use Getsolaris\LaravelTossPayments\Attributes\CashReceipt;
296-
297-
$cashReceipt = TossPayments::for(CashReceipt::class)
298-
->receiptKey($receiptKey)
299-
->cancel();
300-
301-
return $cashReceipt->json();
302-
```
303-
304-
### [현금영수증 조회](https://docs.tosspayments.com/reference#%ED%98%84%EA%B8%88%EC%98%81%EC%88%98%EC%A6%9D-%EC%A1%B0%ED%9A%8C)
305-
306-
GET /v1/cash-receipts
307-
308-
```php
309-
use Getsolaris\LaravelTossPayments\TossPayments;
310-
use Getsolaris\LaravelTossPayments\Attributes\CashReceipt;
311-
312-
$cashReceipts = TossPayments::for(CashReceipt::class)
313-
->requestDate($requestDate)
314-
->get();
315-
316-
return $cashReceipts->json();
317-
```
72+
[예제 보기](examples/CASHRECEIPT.md)
31873

31974

32075
## [카드사 혜택 조회 (Promotion)](https://docs.tosspayments.com/reference#%EC%B9%B4%EB%93%9C%EC%82%AC-%ED%98%9C%ED%83%9D-%EC%A1%B0%ED%9A%8C)
32176

322-
### [카드사 혜택 조회](https://docs.tosspayments.com/reference#%EC%B9%B4%EB%93%9C%EC%82%AC-%ED%98%9C%ED%83%9D-%EC%A1%B0%ED%9A%8C-1)
323-
324-
GET /v1/promotions/card
325-
326-
```php
327-
use Getsolaris\LaravelTossPayments\TossPayments;
328-
use Getsolaris\LaravelTossPayments\Attributes\Promotion;
329-
330-
$promotions = TossPayments::for(Promotion::class)
331-
->get();
332-
333-
return $promotions->json();
334-
```
77+
[예제 보기](examples/PROMOTION.md)
33578

33679

33780
## [테스트 코드 사용하기](https://docs.tosspayments.com/reference/error-codes#%EC%97%90%EB%9F%AC-%EC%BD%94%EB%93%9C)

‎examples/BILLING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## [자동 결제 (Billing)](https://docs.tosspayments.com/reference#%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C)
2+
3+
### [customerKey로 카드 자동 결제 빌링키 발급 요청](https://docs.tosspayments.com/reference#customerkey%EB%A1%9C-%EC%B9%B4%EB%93%9C-%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C-%EB%B9%8C%EB%A7%81%ED%82%A4-%EB%B0%9C%EA%B8%89-%EC%9A%94%EC%B2%AD)
4+
5+
POST /v1/billing/authorizations/card
6+
7+
```php
8+
use Getsolaris\LaravelTossPayments\TossPayments;
9+
use Getsolaris\LaravelTossPayments\Attributes\Billing;
10+
11+
$billing = TossPayments::for(Billing::class)
12+
->customerKey($customerKey)
13+
->cardNumber($cardNumber)
14+
->cardExpirationYear($cardExpirationYear)
15+
->cardExpirationMonth($cardExpirationMonth)
16+
->customerIdentityNumber($customerIdentityNumber)
17+
->authorizationsCard();
18+
19+
return $billing->json();
20+
```
21+
22+
### [authKey로 카드 자동 결제 빌링키 발급 요청](https://docs.tosspayments.com/reference#authkey%EB%A1%9C-%EC%B9%B4%EB%93%9C-%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C-%EB%B9%8C%EB%A7%81%ED%82%A4-%EB%B0%9C%EA%B8%89-%EC%9A%94%EC%B2%AD)
23+
24+
POST /v1/billing/authorizations/issue
25+
26+
```php
27+
use Getsolaris\LaravelTossPayments\TossPayments;
28+
use Getsolaris\LaravelTossPayments\Attributes\Billing;
29+
30+
$billing = TossPayments::for(Billing::class)
31+
->customerKey($customerKey)
32+
->authKey($authKey)
33+
->authorizationsIssue();
34+
35+
return $billing->json();
36+
```
37+
38+
### [카드 자동 결제 승인 요청](https://docs.tosspayments.com/reference#%EC%B9%B4%EB%93%9C-%EC%9E%90%EB%8F%99-%EA%B2%B0%EC%A0%9C-%EC%8A%B9%EC%9D%B8-%EC%9A%94%EC%B2%AD)
39+
40+
POST /v1/billing/{billingKey}
41+
42+
```php
43+
use Getsolaris\LaravelTossPayments\TossPayments;
44+
use Getsolaris\LaravelTossPayments\Attributes\Billing;
45+
46+
$billing = TossPayments::for(Billing::class)
47+
->customerKey($customerKey)
48+
->authKey($authKey)
49+
->authorizationsIssue();
50+
51+
return $billing->json();
52+
```

0 commit comments

Comments
 (0)