웹훅 이벤트

캔디페이에서 제공하는 웹훅 이벤트 목록입니다.

모든 웹훅 API는 추가 계약(무료) 후 사용할 수 있습니다. 추가 계약을 하고 싶다면 캔디페이 공식 이메일(help@atones.co.kr)로 문의해주세요. 문의 내용에 웹훅을 받고 싶은 엔드포인트를 포함해주세요.

웹훅 헤더

캔디페이 웹훅은 다음과 같은 헤더가 있습니다.


candypay-webhook-transmission-time: 2024-09-05T12:19:21+09:00

캔디페이 결제 상태를 알려주는 웹훅입니다.

웹훅이 발송되는 결제 상태는 아래 그림에서 푸른 색의 상태에 도달할 때 입니다.


{
  "eventType": "PAYMENT_STATUS_CHANGED",
  "createdAt": "2022-01-01T00:00:00.000000",
  "data": {
    /** PaymentIntent 객체 */
  }
}

data 필드에 PaymentIntent 객체를 담아 보내줍니다.

정산이 발생할 때마다 알려주는 웹훅입니다.


{
  "eventType": "SETTLEMENT_CREATED",
  "createdAt": "2022-01-01T00:00:00.000000",
  "data": {
    /** Settlement 객체 */
  }
}

data 필드에 Settlement 객체를 담아 보내줍니다.