결제 환불
결제 완료 건의 결제 금액 중 일부 또는 전부를 구매자에게 돌려줍니다.
각 API 응답 필드와 에러코드는 사전 공지 없이 추가되거나 변경될 수도 있으니, 추가된 항목으로 인해 오류가 발생하지 않도록 처리에 유의해 주시기 바랍니다.
https://pay.toss.im/api/v2/refunds요청 파라미터
apiKeystring필수가맹점 API Key. 웹 브라우저 혹은 외부에 노출되지 않도록 유의해 주시기 바랍니다.
payTokenstring필수토스페이 토큰
orderNostring가맹점 주문번호
refundNostring필수환불 번호. 환불 번호는 요청 시 가맹점별로 매회 유니크한 값을 입력해야 하며, 중복 입력 시 환불 요청이 실패합니다. 최대 36자 이내의 문자열을 사용해야 하며 빈 문자열 또는 null로 전달하면 오류가 발생합니다.
reasonstring환불 사유. 한글 및 숫자, 영문자, 특수문자를 허용합니다.
amountinteger (int64)환불할 금액. 미입력 시 환불할 결제건의 남은 전액을 환불 처리하며, 부분환불 시 필수로 amount를 활용해주세요. 즉시할인이 적용된 거래의 부분환불이 필요한 경우, 가맹점에서는 환불이 필요한 총 요청 금액만 전달해 주시면 됩니다.
amountTaxableinteger (int64)환불할 금액 중 과세금액
amountVatinteger (int64)환불할 금액 중 부가세. 값이 없으면 환불할 과세금액을 11로 나눈 후 소수점 첫째 자리에서 올림으로 계산합니다.
amountServiceFeeinteger (int64)환불할 금액 중 봉사료. 결제 생성 시 봉사료 설정한 경우에만 입력 가능
amountTaxFreeinteger (int64)환불할 금액 중 비과세금액. 없으면 0으로 설정합니다.
idempotentboolean멱등성 적용 여부. true: 사용 (기본값), false: 미사용. 멱등성 적용 시 동일한 요청을 반복적으로 수행하더라도 동일한 결과인 성공으로 응답 처리됩니다.
응답 파라미터
codeinteger (int32)응답코드. 0: 성공, -1: 실패 (실패 사유는 msg와 errorCode로 제공)
errorCodestring에러 코드
msgstring응답이 성공이 아닌 경우 설명 메시지
refundNostring환불 번호. 환불요청 시 가맹점이 전달한 refundNo로 리턴됩니다.
approvalTimestring결제건의 환불 처리 시간 (yyyy-MM-dd HH:mm:ss)
cashReceiptMgtKeystring현금영수증 관리번호 식별값
refundableAmountinteger (int64)환불 가능 금액. 환불 성공 후 남은 환불 가능 금액
discountedAmountinteger (int64)할인된 금액. 환불 성공 후 남은 할인적용 금액
paidPointinteger (int64)포인트 사용 금액
paidAmountinteger (int64)지불수단 승인금액. 환불 성공 후 남은 지불수단의 승인금액
refundedAmountinteger (int64)환불요청 금액. 가맹점에서 환불 요청 시 전달한 amount 금액
refundedDiscountAmountinteger (int64)환불요청 금액 중 실 차감된 할인 금액
refundedPointinteger (int64)환불된 포인트 금액
refundedPaidAmountinteger (int64)환불요청 금액 중 실 차감된 지불수단 금액
payTokenstring환불된 결제토큰
transactionIdstring거래 트랜잭션 아이디
payStatusstring결제 상태. PAY_COMPLETE: 결제 완료, REFUND_SUCCESS: 환불 성공 등
payMethodstring결제수단. TOSS_MONEY: 토스머니, CARD: 카드
TOSS_MONEYTOSSPAY_MONEYCARDACCOUNTRESELLER_CARDBNPLaccountBankCodestring은행코드
accountBankNamestring은행명
accountNumberstring마스킹된 계좌번호
cardNum4Printstring사용자가 선택한 카드의 끝 4자리
cardNumberstring마스킹된 카드번호
cardBinNumberstring카드 BIN 번호
cardUserTypestring카드 사용자 구분. PERSONAL: 본인 카드, PERSONAL_FAMILY: 가족 카드, CORP_PERSONAL: 법인지정 결제계좌 임직원, CORP_PRIVATE: 법인 공용
NONEPERSONALPERSONAL_FAMILYCORP_PERSONALCORP_PRIVATECORP_COMPANYGIFTcardMethodTypestring카드 타입. CREDIT: 신용카드, CHECK: 체크카드, PREPAYMENT: 선불카드
CREDITCHECKPREPAYMENTNONE