PG승인대사

PG승인대사 목록 조회

post

기능설명

PG승인대사에 대한 목록을 조회합니다.

상세설명

화면에서 넘어온 조건에 맞는 PG 승인대사 목록을 조회합니다.
승인대사 목록의 대사결과를 조회합니다.
PG승인대사결과사유(AC005)
- 금액일치(10) : EC 결제금액, PG 거래금액 일치
- 금액불일치(20) : EC 결제금액, PG 거래금액이 모두 존재 + EC 결제금액, PG 거래금액 불일치
- PG사누락(30) : PG사 데이터 미존재
- BO시스템누락(40) : EC 데이터 미존재
- 기타(99) : 그 외

코드정리

EC/PG구분코드 : 10: EC 결과 조회, 20: PG사 결과 조회

수정번호

Release v1.04_231120: PG승인대사 최초 개발
Release v2.00_240613: 기간 검색 조건 개선

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PG승인대사 목록 조회 요청 DTO

siteNostringOptional

사이트번호

Example: 1

startDatestring · dateOptional

조회시작일자

Example: 2023-10-10

endDatestring · dateOptional

조회종료일자

Example: 2023-10-12

ordNostringOptional

주문번호

Example: 20990101O000001

payGbCdstringOptional

결제구분코드(OM012)

Example: 10

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

payWayCdstringOptional

결제수단코드(OM013)

Example: 11

compareResultstringOptional

대사결과

Example: 0

mersNostringOptional

가맹점번호

Example: 1

termlIdstringOptional

터미널ID

Example: INIPayTest

trdNostringOptional

거래번호

Example: INIMX_CARDINIpayTest20990101090000685510

ecPgGbCdstringOptional

EC/PG구분코드

Example: 10

mersEtcGbCdListstring[]Optional

가맹점기타구분코드(OM052) 리스트

Example: [10,99]

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

post/v2/adjust/pgApproval/getPgApprovalCompareList

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

{
  "siteNo": 1,
  "startDate": "2023-10-10",
  "endDate": "2023-10-12",
  "ordNo": "20990101O000001",
  "payGbCd": 10,
  "pgGbCd": 10,
  "payWayCd": 11,
  "compareResult": 0,
  "mersNo": 1,
  "termlId": "INIPayTest",
  "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
  "ecPgGbCd": 10,
  "mersEtcGbCdList": [
    10,
    99
  ]
}

{
  "totalCount": 1,
  "payloads": [
    {
      "trdDt": "2023-10-13",
      "pgGbNm": "이니시스",
      "mersEtcGbNm": "정기결제",
      "termlId": "INIPayTest",
      "ordNo": "20230912O058151",
      "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
      "payWayNm": "신용카드",
      "payGbCd": 10,
      "payGbNm": "결제",
      "payNo": 1,
      "payAmt": 10000,
      "trdAmt": 10000,
      "trdStatNm": "승인",
      "diffAmt": 0,
      "compareResult": "금액일치",
      "aprvDscdCausConts": "BO누락",
      "totalCount": 100
    }
  ]
}

PG승인대사 불일치사유 저장

post

기능설명

PG승인대사에 대한 불일치 사유를 저장합니다.

상세설명

주문번호, 거래번호, 결제구분코드, 승인불일치사유내용은 필수입니다.
대사금액 차이가 0일 시(금액이 일치할 시) 불일치 사유를 등록할 수 없습니다.
단 건만 등록 가능합니다.

수정번호

Release v1.04_231120: PG승인대사 최초 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PG승인대사 불일치사유 저장 요청 DTO

ordNostringOptional

주문번호

Example: 20231018O061753

trdNostringOptional

거래번호

Example: StdpayCARDINIpayTest20231018152157946499

payGbCdstringOptional

결제구분코드(OM012)

Example: 10

aprvDscdCausContsstringOptional

승인불일치사유내용

Example: 승인불일치 사유 내용

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/adjust/pgApproval/savePgApprovalCompareDscdCaus

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

{
  "ordNo": "20231018O061753",
  "trdNo": "StdpayCARDINIpayTest20231018152157946499",
  "payGbCd": 10,
  "aprvDscdCausConts": "승인불일치 사유 내용"
}

No content

PG승인정보 수신

post

기능설명

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

상세설명

PG구분코드, 조회 시작/종료일시에 해당하는 PG 사의 승인대사목록 정보를 수신합니다.
PG 승인대사를 위해 조회한 승인목록 정보를 저장합니다.
PG 사에서 승인된 승인/취소 건을 저장해 EC 시스템의 결제 내역과 비교합니다.
입금확정여부가 Y인 건은 수신할 수 없습니다.

수정번호

Release v1.04_231120: PG승인대사 최초 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

startDatestring · dateOptional

조회시작일자

Example: 20230101

endDatestring · dateOptional

조회종료일자

Example: 20230131

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

siteNostringOptional

사이트번호

Example: 1

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/adjust/pgApproval/receivePgApprovalList

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

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

No content

PG승인대사 요약 조회

post

기능설명

PG승인대사에 대한 요약내용을 조회합니다.

상세설명

화면에서 넘어온 조건에 맞는 PG 승인대사 요약 내용을 조회합니다.
조회 날짜에 해당하는 BO 시스템 승인/취소 건, PG 사 승인/취소 건, 두 승인/취소 건에 대한 차이 건 수 및 차액의 합을 조회합니다.

수정번호

Release v1.04_231120: PG승인대사 최초 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PG승인대사 목록 조회 요청 DTO

siteNostringOptional

사이트번호

Example: 1

startDatestring · dateOptional

조회시작일자

Example: 2023-10-10

endDatestring · dateOptional

조회종료일자

Example: 2023-10-12

ordNostringOptional

주문번호

Example: 20990101O000001

payGbCdstringOptional

결제구분코드(OM012)

Example: 10

pgGbCdstringOptional

PG구분코드(OM030)

Example: 10

payWayCdstringOptional

결제수단코드(OM013)

Example: 11

compareResultstringOptional

대사결과

Example: 0

mersNostringOptional

가맹점번호

Example: 1

termlIdstringOptional

터미널ID

Example: INIPayTest

trdNostringOptional

거래번호

Example: INIMX_CARDINIpayTest20990101090000685510

ecPgGbCdstringOptional

EC/PG구분코드

Example: 10

mersEtcGbCdListstring[]Optional

가맹점기타구분코드(OM052) 리스트

Example: [10,99]

Responses

200

성공

*/*

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

payAprvCnclCntinteger · int64Optional

EC 승인/취소 건수

Example: 1

payAprvCnclAmtinteger · int64Optional

EC 승인/취소 금액

Example: 10000

pgAprvCnclCntinteger · int64Optional

PG 승인/취소 건수

Example: 1

pgAprvCnclAmtinteger · int64Optional

PG 승인/취소 금액

Example: 10000

diffAprvCnclCntinteger · int64Optional

EC-PG 승인/취소 건수 차

Example: 0

diffAprvCnclAmtinteger · int64Optional

EC-PG 승인/취소 금액 차

Example: 0

startDatestring · dateOptional

조회시작일자

Example: 2023-10-01

endDatestring · dateOptional

조회종료일자

Example: 2023-10-03

payGbCdstringOptional

결제구분코드(OM012)

Example: 10

900

업무처리 오류 내용

*/*

post/v1/adjust/pgApproval/getPgApprovalCompareSummary

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

{
  "siteNo": 1,
  "startDate": "2023-10-10",
  "endDate": "2023-10-12",
  "ordNo": "20990101O000001",
  "payGbCd": 10,
  "pgGbCd": 10,
  "payWayCd": 11,
  "compareResult": 0,
  "mersNo": 1,
  "termlId": "INIPayTest",
  "trdNo": "INIMX_CARDINIpayTest20990101090000685510",
  "ecPgGbCd": 10,
  "mersEtcGbCdList": [
    10,
    99
  ]
}

[
  {
    "payAprvCnclCnt": 1,
    "payAprvCnclAmt": 10000,
    "pgAprvCnclCnt": 1,
    "pgAprvCnclAmt": 10000,
    "diffAprvCnclCnt": 0,
    "diffAprvCnclAmt": 0,
    "startDate": "2023-10-01",
    "endDate": "2023-10-03",
    "payGbCd": 10
  }
]

이전정산(Settlement) BO API 다음PG정산대사

마지막 업데이트 4개월 전