PG정산대사

PG정산대사 목록 조회

post

기능설명

• PG정산대사 목록을 조회합니다.

---

상세설명

• 화면에서 넘어온 조건에 맞는 PG 정산대사 내용을 조회합니다.

• 조회 날짜에 맞는 EC 시스템 승인/취소 건, PG 사 승인/취소 건의 금액 정보와 두 승인/취소 건에 대한 입금예정액, 입금금액 차이의 합을 조회합니다.

---

코드정리

• 조회날짜기준(searchDateType) : aprvDt: 승인일자 기준 조회, dptDt: 입금일자 기준 조회

---

수정번호

• Release v1.04_231120: PG정산대사 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PG정산대사 목록 조회 요청 DTO

searchDateTypestringOptional

조회날짜기준타입

Example: aprvDt

startDatestring · dateOptional

조회시작일자

Example: 2023-10-10

endDatestring · dateOptional

조회종료일자

Example: 2023-10-12

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

trdNostringOptional

거래번호

Example: INIMX_CARDINIpayTest20990101090000685510

dptCfmYnstringOptional

입금확정여부

Example: Y

payWayCdstringOptional

결제수단코드(OM013)

Example: 11

ordNostringOptional

주문번호

Example: 20990101O000001

termlIdstringOptional

터미널ID

Example: INIPayTest

payStatCdstringOptional

결제구분

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

post

/v2/adjust/pgAdjust/getPgAdjustCompareList

HTTPcURLJavaScriptPython

POST /api/bo/v2/adjust/pgAdjust/getPgAdjustCompareList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "searchDateType": "aprvDt",
  "startDate": "2023-10-10",
  "endDate": "2023-10-12",
  "pgGbCd": 10,
  "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
  "dptCfmYn": "Y",
  "payWayCd": 11,
  "ordNo": "20990101O000001",
  "termlId": "INIPayTest",
  "payStatCd": "text"
}

{
  "totalCount": 1,
  "payloads": [
    {
      "infLogSeq": 1,
      "pgGbCd": 10,
      "pgGbNm": "이니시스",
      "mersEtcGbNm": 10,
      "ordNo": "20230912O058151",
      "payStatus": "결제완료",
      "payWayNm": "신용카드",
      "aprvCnclDt": "2023-10-20",
      "payAmt": 10000,
      "expectedFee": 300,
      "expectedDepositAmt": 9700,
      "approveAmt": 10000,
      "paymentFee": 300,
      "depositAmt": 9700,
      "dptDt": "2023-10-20",
      "etcAdjAmt": 100,
      "depositAmtDiff": 0,
      "adjAjstCausConts": "사유",
      "dptCfmYn": "Y",
      "dptCfmDtm": "2023-10-20 00:00:00.000",
      "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
      "termlId": "INIPayTest",
      "payGbCd": 10,
      "totalCount": 100
    }
  ]
}

PG정산대사 조정사유 저장

post

기능설명

• PG정산대사에 대한 조정 사유를 저장합니다.

---

상세설명

• 주문번호, 거래번호, 결제구분코드, 정산조정사유내용, 기타정산금액은 필수입니다.

• 입금금액 차이가 0일 시(금액이 일치할 시) 조정 사유를 등록할 수 없습니다.

• 단 건만 등록 가능합니다.

---

수정번호

• Release v1.04_231120: PG정산대사 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PG 정산대사 조정 사유 등록 요청 DTO

ordNostringOptional

주문번호

Example: 20230808O007404

trdNostringOptional

거래번호

Example: StdpayCARDINIpayTest20231018152157946499

payGbCdstringOptional

결제구분코드(OM012)

Example: 10

etcAdjAmtnumberOptional

기타정산금액

Example: 100

adjAjstCausContsstringOptional

정산조정사유내용

Example: 정산조정사유내용

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post

/v1/adjust/pgAdjust/savePgAdjustCompareAjstCaus

HTTPcURLJavaScriptPython

POST /api/bo/v1/adjust/pgAdjust/savePgAdjustCompareAjstCaus HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "ordNo": "20230808O007404",
  "trdNo": "StdpayCARDINIpayTest20231018152157946499",
  "payGbCd": 10,
  "etcAdjAmt": 100,
  "adjAjstCausConts": "정산조정사유내용"
}

No content

PG정산정보 수신

post

기능설명

• 선택한 날짜, PG구분코드에 대한 PG정산정보를 수신해 저장합니다.

---

상세설명

• PG구분코드, 조회 시작/종료일시에 해당하는 PG 사의 정산대사목록 정보를 수신합니다.

• PG 정산대사를 위해 조회한 정산목록 정보를 저장합니다.

• 입금확정여부가 Y인 건은 수신할 수 없습니다.

• 수신한 데이터는 PG정산대사 화면에서 볼 수 있습니다.

---

수정번호

• Release v1.04_231120: PG정산대사 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PG 승인/정산 정보수신 요청 DTO

startDatestring · dateOptional

조회시작일자

Example: 20230101

endDatestring · dateOptional

조회종료일자

Example: 20230131

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post

/v1/adjust/pgAdjust/receivePgAdjustList

HTTPcURLJavaScriptPython

POST /api/bo/v1/adjust/pgAdjust/receivePgAdjustList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "startDate": 20230101,
  "endDate": 20230131,
  "pgGbCd": 10
}

No content

PG정산대사 입금확정/입금확정 취소 처리

post

기능설명

• PG정산대사에 대한 입금확정/입금확정 취소를 처리합니다.

---

상세설명

• 인터페이스로그순번, 입금확정여부는 필수입니다.

• 입금확정 시 필수 체크 항목

  • 기존 데이터 입금확정 미처리상태 (N)

  • 기존 데이터 입금확정일시 null

  • EC데이터, PG데이터 입금금액차이 0

• 입금확정 취소 시 필수 체크 항목

  • 기존 데이터 입금확정 처리상태 (Y)

  • 기존 데이터 입금확정일시 not null

---

수정번호

• Release v1.04_231120: PG정산대사 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

PG 정산대사 입금 확정 및 확정취소 요청 DTO

infLogSeqstringOptional

인터페이스로그순번

Example: 1

dptCfmYnstringOptional

입금확정여부

Example: Y

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post

/v1/adjust/pgAdjust/processDepositConfirmAndCancel

HTTPcURLJavaScriptPython

POST /api/bo/v1/adjust/pgAdjust/processDepositConfirmAndCancel HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

[
  {
    "infLogSeq": 1,
    "dptCfmYn": "Y"
  }
]

No content

PG정산대사 요약 조회

post

기능설명

• PG정산대사에 대한 요약내용을 조회합니다.

---

상세설명

• 화면에서 넘어온 조건에 맞는 PG 정산대사 요약 내용을 조회합니다.

• 조회 날짜에 맞는 EC 시스템 승인/취소 건, PG 사 승인/취소 건의 금액 정보와 두 승인/취소 건에 대한 입금예정액, 입금금액 차이의 합을 조회합니다.

• EC 시스템 데이터 기준

  • 결제금액: 실결제금액

  • 예정수수료: 결제 데이터의 가맹점 정보에 의해 계산된 수수료

  • 입금예정액: 결제금액 - 예정수수료

• PG 데이터 기준

  • 승인금액: PG 거래금액

  • 결제수수료: PG 데이터 결제수수료 + PG 데이터 부가세

  • 입금금액: PG 데이터 입금금액 (승인금액-결제수수료)

• 입금금액차이: 입금예정액 - 입금금액

---

코드정리

• 조회날짜기준(searchDateType) : aprvDt: 승인일자 기준 조회, dptDt: 입금일자 기준 조회

---

수정번호

• Release v1.04_231120: PG정산대사 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PG정산대사 목록 조회 요청 DTO

searchDateTypestringOptional

조회날짜기준타입

Example: aprvDt

startDatestring · dateOptional

조회시작일자

Example: 2023-10-10

endDatestring · dateOptional

조회종료일자

Example: 2023-10-12

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

trdNostringOptional

거래번호

Example: INIMX_CARDINIpayTest20990101090000685510

dptCfmYnstringOptional

입금확정여부

Example: Y

payWayCdstringOptional

결제수단코드(OM013)

Example: 11

ordNostringOptional

주문번호

Example: 20990101O000001

termlIdstringOptional

터미널ID

Example: INIPayTest

payStatCdstringOptional

결제구분

Responses

200

성공

*/*

PG승인대사 요약 조회 응답 DTO

payAmtnumberOptional

결제금액

Example: 10000

expectedFeeinteger · int64Optional

예정수수료

Example: 300

expectedDepositAmtinteger · int64Optional

입금예정금액

Example: 9700

approveAmtinteger · int64Optional

승인금액

Example: 10000

paymentFeeinteger · int64Optional

결제수수료

Example: 500

depositAmtinteger · int64Optional

입금금액

Example: 9500

etcAdjAmtnumberOptional

기타조정금액

Example: 200

depositAmtDiffinteger · int64Optional

입금금액차이

Example: 0

startDatestring · dateOptional

조회시작일자

Example: 2023-10-01

endDatestring · dateOptional

조회종료일자

Example: 2023-10-03

900

업무처리 오류 내용

*/*

post

/v1/adjust/pgAdjust/getPgAdjustCompareSummary

HTTPcURLJavaScriptPython

POST /api/bo/v1/adjust/pgAdjust/getPgAdjustCompareSummary HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "searchDateType": "aprvDt",
  "startDate": "2023-10-10",
  "endDate": "2023-10-12",
  "pgGbCd": 10,
  "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
  "dptCfmYn": "Y",
  "payWayCd": 11,
  "ordNo": "20990101O000001",
  "termlId": "INIPayTest",
  "payStatCd": "text"
}

[
  {
    "payAmt": 10000,
    "expectedFee": 300,
    "expectedDepositAmt": 9700,
    "approveAmt": 10000,
    "paymentFee": 500,
    "depositAmt": 9500,
    "etcAdjAmt": 200,
    "depositAmtDiff": 0,
    "startDate": "2023-10-01",
    "endDate": "2023-10-03"
  }
]