TRANSFER_DELEGATION_STATUS_CHANGED
토스페이먼츠 개발자센터 웹훅 페이지에서 ’웹훅 등록하기’를 누르세요. 웹훅 이벤트 등록 팝업창에서 웹훅 이름, 웹훅 URL을 입력하고 TRANSFER_DELEGATION_STATUS_CHANGED 이벤트를 선택하세요. 마지막으로 '등록하기' 를 누르세요.
지급대행 요청 상태가 COMPLETED, FAILED로 변경되면 아래 웹훅 이벤트가 전송됩니다. 자세한 상태 설명은TransferDelegation 객체의 status 에서 확인하세요.
이벤트 본문
{
"eventType": "TRANSFER_DELEGATION_STATUS_CHANGED",
"createdAt": "2023-10-01T00:00:00.00000",
"data": {
"transferDelegationKey": "FPA20231001_000000000001",
"subMallId": "mall1",
"type": "INSTANT",
"transferDate": "2023-10-01",
"transferAmount": 50000,
"requestedAt": "2023-10-01T00:00:00+09:00",
"account": null,
"status": "COMPLETED",
"metadata": null,
"failure": null,
"transferSummary": "김토스"
}
}
JSON
복사
eventType 필수 · string
웹훅 이벤트 타입입니다.
createdAt 필수 · string
웹훅이 생성된 시간입니다. yyyy-MM-dd'T'HH:mm:ss.SSSSSS ISO 8601 형식입니다.
data 필수 · string
상태가 변경된 TransferDelegation객체 입니다.
TransferDelegation 객체
지급대행 한 건의 정보입니다.
transferDelegationKey string
지급대행 한 건의 키입니다. 최대 길이는 24자입니다.
subMallId string
서브몰의 ID입니다. 최대 길이는 20자입니다.
type string
즉시・예약 지급대행 유형을 구분합니다. INSTANT는 즉시 지급대행 건입니다. SCHEDULED는 예약 지급대행 건입니다.
transferDate string
지급일입니다. yyyy-MM-dd 형식입니다.
transferAmount number
지급할 금액입니다.
requestedAt string
지급거래를 요청한 일입니다. yyyy-MM-dd'T'HH:mm:ss±hh:mm 형식입니다.
account nullable ・ object
서브몰의 계좌 정보를 담은 객체입니다.
status string
지급대행 상태입니다. 아래와 같은 상태 값을 가질 수 있습니다.
•
REQUESTED: 지급이 요청된 상태입니다.
•
IN_PROGRESS: 지급을 처리하고 있는 상태입니다.
•
COMPLETED: 서브몰에 지급이 완료된 상태입니다.
•
FAILED: 지급 요청이 실패한 상태입니다.
•
CANCELED: 지급 요청을 취소한 상태입니다.
metadata nullable ・ object
서브몰과 관련된 추가 정보를 key-value 쌍으로 담고 있는 객체입니다. 최대 50개의 key-value 쌍을 포함할 수 있으며 전체 크기는 4kB 이하입니다.
failure nullable ・ object
지급대행 요청이 실패하면 보내주는 정보입니다. status 필드가 FAILED 일 때만 정보를 보여줍니다.
ㄴ code string
오류 타입을 보여주는 에러 코드입니다. INVALID_ACCOUNT, TRANSFER_FAILED 두 가지 코드만 돌아옵니다.
ㄴ message string
에러 메시지입니다. 에러 발생 이유를 알려줍니다.
transferSummary string
지급대행으로 입금된 금액의 세부 내용(적요)입니다. 서브몰 통장에 표기되는 정보입니다. 최대 길이는 7자입니다.