정산 API
지급일 또는 거래 승인일 기준으로 정산 상세 내역을 조회합니다.
각 API 응답 필드와 에러코드는 사전 공지 없이 추가되거나 변경될 수도 있으니, 추가된 항목으로 인해 오류가 발생하지 않도록 처리에 유의해 주시기 바랍니다.
요청 파라미터
apiKeystring필수가맹점 API Key. Test API Key로 요청할 경우 테스트 결제는 실제 지급되지 않아 정산 대상이 아니므로, 빈 목록(transactionList: [])과 0원 합계가 응답됩니다.
dateTypestring필수기준 날짜의 형태. DUE: 지급일 (정산 계좌에 입금된 날짜), SETTLE: 거래 승인일 (결제 시점의 날짜)
baseDatestring필수조회하고자 하는 날짜 (yyyyMMdd 형식). 승인일 기준 최대 1년까지 조회 가능합니다. 당일 자 데이터를 조회하는 경우, dateType이 DUE이면 09:00 이후 호출해 주세요. dateType이 SETTLE이면 당일 승인 건은 익일 적재되므로 조회 결과가 없습니다. 자세한 내용은 정산 API 조회 시 유의사항을 참고해 주세요.
nextCursorstring페이징 cursor 값. 파라미터가 추가되지 않으면 첫 페이징 데이터가 리턴됩니다.
payMethodstring조회하고자 하는 결제수단. 보내지 않거나 null로 보내면 모든 결제수단에 대해 응답합니다. TOSS_MONEY: 토스머니, CARD: 카드, RESELLER_CARD: 카드(리셀러 계약 가맹점)
TOSS_MONEYCARDRESELLER_CARD응답 파라미터
transactionListSettlementTransaction[]정산 내역 리스트 (최대 1000개)
transactionTypestring거래 종류. PAY: 결제, REFUND: 환불
transactionIdstring거래 고유번호. 부분 환불 건도 건별로 별도 발급됩니다.
payTokenstring토스페이 결제 고유 토큰. 환불 건은 원결제와 동일한 값이 응답됩니다.
productDescstring상품 설명. 결제 생성 시 가맹점이 전달한 값입니다.
orderNostring가맹점 주문번호. 결제 생성 시 가맹점이 전달한 값입니다.
amountinteger (int64)수수료 부과 대상 금액. 실결제금액, 토스 부담 금액, 포인트 사용 금액을 합산한 금액입니다. 결제는 양수(+), 환불은 음수(-)로 응답됩니다.
feeinteger (int32)수수료. 부과 시 음수(-), 환불 시 양수(+)로 응답됩니다.
vatinteger (int32)수수료 부가세. 부과 시 음수(-), 환불 시 양수(+)로 응답됩니다.
payMethodstring결제수단. TOSS_MONEY, CARD, RESELLER_CARD
TOSS_MONEYCARDRESELLER_CARDfeeVatSuminteger (int32)수수료와 부가세의 합계 (fee + vat)
settleDatestringDeprecated. 거래 승인일 (yyyyMMdd). 신규 연동 시 사용을 권장하지 않습니다.
dueDatestring지급일 (yyyyMMdd)
settleDateTimestringDeprecated. 거래 처리 일시 (yyyyMMddHHmmss). 요청 조건에 따라 응답에 포함되지 않을 수 있으며, 신규 연동 시 사용을 권장하지 않습니다.
nextCursorstring커서 값. 다음 페이징 데이터가 있으면 커서 값을 반환, 마지막 페이징일 경우 빈 스트링을 반환
totalAmountinteger (int64)총 수수료 부과 대상 금액 합산. 조회된 전체 건의 수수료 부과 대상 금액 합산
totalFeeinteger (int64)총 수수료 합산. 조회된 전체 건의 총 수수료 합산
totalVatinteger (int64)총 부가세 합산. 조회된 전체 건의 총 부가세 합산
totalFeeVatSuminteger (int64)총 수수료 + 부가세 합산 (totalFee + totalVat)