정산 조회

interface Settlemet {
  /**
  * 정산의 id값 입니다. 캔디페이에서 각 정산별로 자동으로 생성해주는 문자열입니다.
  * 정산되지 않은 결제건일 경우 null을 반환합니다.
  */
  settlementId: string | null
  /**
  * 결제 요청 시 입력 받은 주문번호 입니다.
  */
  orderId: string
  /**
  * 결제 요청 시 입력받은 주문의 이름입니다.
  */
  orderName: string
  /**
   * 총 결제 거래액입니다.
   */
  transactionAmount: number
  /**
   * 해당 결제액의 수수료 입니다.
   */
  fee: number
  /**
   * 해당 결제액의 세액금액입니다. 세액금액은 수수료의 0.1%입니다.
   */
  vat: number
  /**
   * 최종 정산금액 입니다.
   * transactionAmount - fee - vat으로 계산됩니다.
   */
  settlementAmount: number
  /**
   * 결제가 승인된 날짜 입니다.
   */
  approvedAt: Date
  /**
   * 캔디페이에서 예상하는 정산일 입니다.
   * 결제 승인 날짜로부터 3영업일 후에 정산이 됩니다.
   */
  scheduledAt: Date
  /**
   * 실제 캔디페이에서 정산을 진행한 정산일 입니다.
  *  아직 정산이 안된 결제건일 경우 null로 반환됩니다.
   */
  settledAt: Date | null
  /**
   * 정산 상태입니다.
   * 'SETTLED'는 정산 완료 'UNSETTLED'는 정산 예정 상태를 의미합니다.
   */
  status: 'SETTLED' | 'UNSETTLED'
}

GET https://api.candypay.co.kr/px/settlements?from=YYYY-MM-DD&to=YYYY-MM-DD

[
 {
        "settlementId": "abcdefghizklmnopqrstuv",
        "orderId": "12345678901234567",
        "orderName": "Test 결제",
        "transactionAmount": 200,
        "fee": 4,
        "vat": 0,
        "settlementAmount": 196,
        "approvedAt": "2026-02-19T06:17:32.401Z",
        "scheduledAt": "2026-02-24T06:17:32.401Z",
        "settledAt": "2026-02-19T00:00:00.000Z",
        "status": "SETTLED"
    }
]

GET https://api.candypay.co.kr/px/settlements/:orderId

{
    "settlementId": "abcdefghizklmnopqrstuv",
    "orderId": "12345678901234567",
    "orderName": "Test 결제",
    "transactionAmount": 200,
    "fee": 4,
    "vat": 0,
    "settlementAmount": 196,
    "approvedAt": "2026-02-19T06:17:32.401Z",
    "scheduledAt": "2026-02-24T06:17:32.401Z",
    "settledAt": "2026-02-19T00:00:00.000Z",
    "status": "SETTLED"
}