-
Notifications
You must be signed in to change notification settings - Fork 12
/
api_settlement.html
475 lines (468 loc) · 18.8 KB
/
api_settlement.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>결제 정산 API</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="https://static.toss.im/tds/favicon/favicon.ico" />
<link rel="icon" type="image/png" sizes="16x16" href="https://static.toss.im/tds/favicon/favicon-16x16.png" />
<link rel="icon" type="image/png" sizes="32x32" href="https://static.toss.im/tds/favicon/favicon-32x32.png" />
<link rel="icon" type="image/png" sizes="48x48" href="https://static.toss.im/tds/favicon/favicon-48x48.png" />
<link rel="icon" type="image/png" sizes="196x196" href="https://static.toss.im/tds/favicon/favicon-196x196.png" />
<link rel="apple-touch-icon" sizes="57x57" href="https://static.toss.im/tds/favicon/apple-touch-icon-57x57.png" />
<link rel="apple-touch-icon" sizes="72x72" href="https://static.toss.im/tds/favicon/apple-touch-icon-72x72.png" />
<link
rel="apple-touch-icon"
sizes="114x114"
href="https://static.toss.im/tds/favicon/apple-touch-icon-114x114.png"
/>
<link
rel="apple-touch-icon"
sizes="120x120"
href="https://static.toss.im/tds/favicon/apple-touch-icon-120x120.png"
/>
<link
rel="apple-touch-icon"
sizes="144x144"
href="https://static.toss.im/tds/favicon/apple-touch-icon-144x144.png"
/>
<link
sizes="152x152"
href="https://static.toss.im/tds/favicon/apple-touch-icon-152x152.png"fdsffsdf
/>
<meta name="msapplication-TileImage" content="https://static.toss.im/tds/favicon/mstile-144x144.png" />
<!-- stylesheets -->
<link
rel="stylesheet"
href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css"
integrity="sha512-dTfge/zgoMYpP7QbHy4gWMEGsbsdZeCXz7irItjcC3sPUFtf0kuFbDz/ixG7ArTxmDjLXDmezHubeNikyKGVyQ=="
crossorigin="anonymous"
/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" />
<link rel="stylesheet" type="text/css" href="css/prism.css" />
<link rel="stylesheet" type="text/css" href="css/tossdev.css" />
<!-- javascript -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
<script
src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"
integrity="sha512-K1qjQ+NcF2TYO/eI3M6v8EiNYZfA95pQumfvcVrTHtwQVDG+aHRqLi/ETn2uB+1JqwYqVG3LIvdm9lj6imS/pQ=="
crossorigin="anonymous"
></script>
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body id="docs" data-spy="scroll" data-target="#guide">
<!-- Google Tag Manager -->
<noscript
><iframe
src="//www.googletagmanager.com/ns.html?id=GTM-TPTMLG"
height="0"
width="0"
style="display:none;visibility:hidden"
></iframe
></noscript>
<script>
(function(w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' });
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != 'dataLayer' ? '&l=' + l : '';
j.async = true;
j.src = '//www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-TPTMLG');
</script>
<!-- End Google Tag Manager -->
<div id="guide">
<div class="logo">
<a href="index.html">
<img class="logo-img" src="https://static.toss.im/tds/icon/svg/logo-only-icon.svg" alt="">
<span>결제 연동 가이드</span>
</a>
</div>
<ul class="menu nav">
<h5>결제 정산 API</h5>
<li>
<a href="#intro">소개</a>
</li>
<h5>용어</h5>
<li>
<a href="#terms">용어 및 정의</a>
</li>
<h5>API 목록</h5>
<li>
<a href="#settlementDetail">정산 API</a>
</li>
</ul>
</div>
<div id="api-docs">
<div id="methods">
<div class="languages">
<a class="language selected" data-lang="php" href="#">PHP</a>
<a class="language" data-lang="java" href="#">Java</a>
<a class="language" data-lang="curl" href="#">curl</a>
<a class="language" data-lang="python" href="#">Python</a>
<a class="language" data-lang="ruby" href="#">Ruby</a>
<a class="language" data-lang="aspnet" href="#">ASP</a>
</div>
<div class="method" id="intro">
<div class="method-section clearfix">
<div class="method-description">
<h3>토스 정산 API 소개 </h3>
<p>
토스 결제 서비스를 통한 매출과 정산 금액 확인을 위한 API 입니다.</br>
페이징 개념을 적용하였고 페이징의 단위는 1,000 건으로 다음 페이징이 존재하면 nextCursor 라는 응답값이 리턴됩니다.</br>
그 후 nextCursor 를 포함하여 호출하면 바로 다음의 페이징 데이터가 리턴됩니다.
</p>
</div>
<div class="method-example">
<pre></pre>
</div>
</div>
</div>
<div class="method" id="terms">
<div class="method-section clearfix">
<div class="method-description">
<h3>용어</h3>
<div class="info">
<h4>용어 및 정의</h4>
<div class="field clearfix">
<div class="key">
지급일
</div>
<div class="desc">
결제 금액을 가맹점의 결제 계좌로 입금한 날입니다.
</div>
</div>
<div class="field clearfix">
<div class="key">
거래 승인일
</div>
<div class="desc">
결제, 환불 등 거래가 실제로 일어난 날입니다.
</div>
</div>
</div>
</div>
<div class="method-example">
<pre>
<code class="curl">
</code>
<code class="java">
</code>
<code class="pho">
</code>
</pre>
</div>
</div>
</div>
<div class="method" id="settlementDetail">
<div class="method-section clearfix">
<div class="method-description">
<h3>정산 API</h3>
<div class="info">
<h4>endpoint</h4>
<div class="field clearfix">
<div class="key">
(POST)
</div>
<div class="desc">
https://pay.toss.im/pay/api/v2/settlement-details
</div>
</div>
</div>
<div class="info">
<h4>parameters</h4>
<div class="field clearfix">
<div class="key">
apiKey
<span class="type">string</span>
<span class="required"></span>
</div>
<div class="desc">
가맹점 key<br/>
<span class="text-muted">Test apiKey도 입력은 가능하나 테스트 결제는 실제 지급되지 않기 때문에 정산 대상이 아니라서 수수료 계산(0원)이나 지급일자(빈값) 등 계산을 건너뛰게 됩니다.
</div>
</div>
<div class="field clearfix">
<div class="key">
dateType
<span class="type">string</span>
<span class="required"></span>
</div>
<div class="desc">
조회 시 기준 날짜의 형태 <br />
<br />
<table class="table">
<tr>
<td>DUE</td>
<td>지급일 (정산 계좌에 입금된 또는 입금될 날짜)</td>
</tr>
<tr>
<td>SETTLE</td>
<td>거래 승인일 (유저가 결제한 시점의 날짜) </td>
</tr>
</table>
</div>
</div>
<div class="field clearfix">
<div class="key">
baseDate
<span class="type">string</span>
<span class="required"></span>
</div>
<div class="desc">
조회 하고자 하는 날짜 (yyyyMMdd)
</div>
</div>
<div class="field clearfix">
<div class="key">
payMethod
<span class="type">string</span>
</div>
<div class="desc">
조회 하고자 하는 결제수단 (보내지 않거나 null 로 보내면 모든 결제수단에 대해 응답)<br />
<br />
<table class="table">
<tr>
<td>TOSS_MONEY</td>
<td>토스머니</td>
</tr>
<tr>
<td>CARD</td>
<td>카드</td>
</tr>
<tr>
<td>RESELLER_CARD</td>
<td>리셀러 카드(리셀러 가맹점에만 해당)</td>
</tr>
</table>
</div>
</div>
<div class="field clearfix">
<div class="key">
nextCursor
<span class="type">string</span>
</div>
<div class="desc">
호출할 페이징의 cursor 값을 나타냅니다. 정산 API 호출 후 리턴되는 응답값을 다음의 정산 API 호출 시 파라미터로 사용하면 됩니다.</br>
<span class="text-muted">해당 파라미터가 추가되지 않고 API 가 호출되면 무조건 첫 페이징 데이터가 리턴됩니다. (index : 0 ~ 999)
</div>
</div>
</div>
<div class="info">
<h4>OPTION PARAMETERS</h4>
<div class="field clearfix">
<div class="key">
includeSettleDateTime
</div>
<div class="desc">
응답으로 '거래 처리 일시' 가 필요한 경우 URI query string 으로 includeSettleDateTime=true 를 넘겨주시면 됩니다.</br>
<span class="text-muted">호출 URI 예시) https://pay.toss.im/pay/api/v2/settlement-details?includeSettleDateTime=true
</div>
</div>
</div>
<div class="info">
<h4>RESPONSE</h4>
<div class="field clearfix">
<div class="key">
transactionList
<span class="type">json</span>
</div>
<div class="desc">
정산 내역 리스트 - 최대 1000 개<br/>
<br/>
<table class="table">
<tr>
<td>transactionType: 거래종류 <br/>
<li>PAY: 결제</li>
<li>REFUND: 환불</li>
</td>
</tr>
<tr>
<td>transactionId: 거래 고유 번호 <br/>
<li>결제 및 환불 시의 거래 고유 번호</li>
<li>동일 결제 건의 부분 환불을 여러번 할 때, 각각의 부분 환불건을 구분하기 위함 </li>
</td>
</tr>
<tr>
<td>settleDate: 거래 승인일</td>
</tr>
<tr>
<td>dueDate: 정산일 (지급일)</td>
</tr>
<tr>
<td>payToken: 토스 결제 토큰</td>
</tr>
<tr>
<td>orderNo: 가맹점의 상품 주문번호</td>
</tr>
<tr>
<td>productDesc: 상품 설명</td>
</tr>
<tr>
<td>payMethod : 결제 수단 <br/>
<li>TOSS_MONEY : 토스머니</li>
<li>CARD : 카드 </li>
<li>RESELLER_CARD : 리셀러 카드</li>
</td>
</tr>
<tr>
<td>amount: 금액 </br>
<span class="text-muted">결제는 '+',<br>환불은 '-'로 표시됨</td>
</tr>
<tr>
<td>fee: 수수료 </br>
<span class="text-muted">수수료 부과는 '-',<br>전액 환불 등 사유로 수수료를 돌려드리는 경우 '+'로 표시됨</td>
</tr>
<tr>
<td>vat: 부가세 </br>
<span class="text-muted">부가세 부과는 '-',<br>전액 환불 등 사유로 부가세를 돌려드리는 경우 '+'로 표시됨</td>
</tr>
<tr>
<td>feeVatSum: 수수료 + 부가세</td>
</tr>
</table>
</div>
</div>
<div class="field clearfix">
<div class="key">
nextCursor
<span class="type">string</span>
</div>
<div class="desc">
API 호출 이후 다음 페이징 영역에 데이터가 존재하면 커서 값이 리턴됩니다. <br/>
<span class="text-muted">마지막 페이징이었다면 빈 스트링이 리턴됩니다.
</div>
</div>
<div class="field clearfix">
<div class="key">
totalAmount
<span class="type">Integer</span>
</div>
<div class="desc">
총 금액 합산 <br/>
<span class="text-muted">(페이징별 합산금액이 아닌) 조회된 전체 건에 대한 총 금액 합산
</div>
</div>
<div class="field clearfix">
<div class="key">
totalFee
<span class="type">Integer</span>
</div>
<div class="desc">
총 수수료 합산 <br/>
<span class="text-muted">(페이징별 합산금액이 아닌) 조회된 전체 건에 대한 총 수수료 합산
</div>
</div>
<div class="field clearfix">
<div class="key">
totalVat
<span class="type">Integer</span>
</div>
<div class="desc">
총 부가세 합산 <br/>
<span class="text-muted">(페이징별 합산금액이 아닌) 조회된 전체 건에 대한 총 부가세 합산
</div>
</div>
<div class="field clearfix">
<div class="key">
totalFeeVatSum
<span class="type">Integer</span>
</div>
<div class="desc">
총 수수료 + 부가세의 합산 (totalFee + totalVat) <br/>
<span class="text-muted">(페이징별 합산금액이 아닌) 조회된 전체 건에 대한 총 수수료+부가세 합산
</div>
</div>
<div class="field clearfix">
<div class="key">
settleDateTime
<span class="type">string</span>
</div>
<div class="desc">
거래 처리 일시<br/>
<span class="text-muted">최종 거래 상태가 승인(PAY) 일 경우는 승인 처리 시각, 환불(REFUND) 일 경우는 환불 처리 시각이 yyyyMMddHHmmss 형태로 리턴됩니다.<br/>
<span class="text-muted"><strong>단, includeSettleDateTime=true 를 포함해서 호출한 경우에만 리턴합니다.</strong>
</div>
</div>
</div>
</div>
<div class="method-example">
<div class="title">Definition</div>
<pre><code class="language-bash always-visible">POST https://pay.toss.im/pay/api/v2/settlement-details</code></pre>
<div class="title">Example Request</div>
<pre><code class="language-javascript always-visible">{
"apiKey": "(example) sk_test_1234567...",
"dateType": "DUE",
"baseDate": "20240314",
"payMethod": "TOSS_MONEY"
// "nextCursor": "99ElA9EGCTJwXpYygHsBnA==" // call with nextCursor
}
</code></pre>
<div class="title">Example Response</div>
<pre><code class="language-javascript always-visible">{
"transactionList": [
{
"transactionType": "REFUND",
"transactionId": "3084ed5d-3267-4ea0-af1c-064bdf0b1462",
"payToken": "example-payToken",
"productDesc": "상품 1",
"orderNo": "order1",
"payMethod": "TOSS_MONEY",
"amount": 10000,
"fee": -40,
"vat": -4,
"payMethod": "TOSS_MONEY",
"feeVatSum": -44,
"settleDate": "20240313",
"dueDate": "20240314"
},
{
"transactionType": "PAY",
"transactionId": "7ba71e5c-28d2-4d8b-946e-6f6b5b3a3205",
"payToken": "example-payToken",
"productDesc": "상품 2",
"orderNo": "order2",
"payMethod": "TOSS_MONEY",
"amount": 33000,
"fee": -132,
"vat": -13,
"payMethod": "TOSS_MONEY",
"feeVatSum": -145,
"settleDate": "20240313",
"dueDate": "20240314"
},
{
.....
}
],
"nextCursor": "",
"totalAmount": 407000,
"totalFee": -1628,
"totalVat": -163,
"totalFeeVatSum": -1791
}
</code></pre>
</div>
<script type="text/javascript">
$(function() {
// language toggle
var $languages = $('.languages .language');
$languages.click(function(e) {
e.preventDefault();
var lang = $(this).data('lang');
$languages.removeClass('selected');
$(this).addClass('selected');
$('pre code').hide();
$('pre code.' + lang).css('display', 'block');
});
$('pre code.' + $('.language.selected').data('lang')).css('display', 'block');
});
</script>
<script src="js/prism.js"></script>
</body>
</html>