For the complete documentation index, see llms.txt. This page is also available as Markdown.

결제내역 조회

마일리지 결제 환불 요청

post

기능설명

  • 환불접수 상태의 마일리지 환불 건들을 환불하는 기능입니다.


상세설명

  • [BO] 주문/결제 > 결제/모니터링 관리 > 마일리지 결제내역 조회 페이지에서 환불완료 버튼 클릭 시 호출됩니다.

  • 복합결제 환불 도중 오류가 발생하여, PG 결제는 환불이 되었으나 마일리지는 환불이 안된 경우 사용하는 기능입니다.

  • 결제구분코드(OM012) : 환불(20), 결제수단코드(OM013) : 마일리지(32), 결제상태코드(OM014) : 환불접수(21) 가 필수 조건입니다.


수정번호

  • Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · MileagePaymentRequest[]

마일리지 결제내역 조회 Request

searchStartDtstring · dateOptional

결제일자(시작)

Example: 2099-01-01
searchEndDtstring · dateOptional

결제일자(끝)

Example: 2099-01-31
ordNostringOptional

주문번호

Example: 20230809O000001
payGbCdstringOptional

결제구분코드(OM012) 10:결제, 20:환불

Example: 10
payStatCdstringOptional

결제상태코드(OM014) 11:결제대기, 12:결제완료, 13:결제취소, 21:환불접수, 22:환불완료, 23:환불접수취소

Example: 12
payStatCdListstring[]Optional

결제상태코드(OM014) 11:결제대기, 12:결제완료, 13:결제취소, 21:환불접수, 22:환불완료, 23:환불접수취소

Example: [12,22]
ordMediaCdstringOptional

주문매체코드(OM007) 10:전화상담(CC), 20:PC, 30:모바일웹, 40:안드로이드앱, 50:IOS앱

Example: 30
payNostringOptional

결제번호

Example: 1
uprPayNostringOptional

상위결제번호

Example: 1
ordDtlGbCdstringOptional

주문상세구분코드(OM003) 10:주문일반, 11:주문취소, 20:반품일반, 21:반품취소, 30:교환주문, 31:교환취소, 40:교환반품

Example: 10
claimNostringOptional

클레임번호

Example: 20230809C000001
rfdAmtnumberOptional

환불요청금액

Example: 1000
payAmtnumberOptional

결제금액

Example: 1000
mbrNostringOptional

회원번호

Example: 100001311
payWayCdstringOptional

결제수단코드(OM013) 11:신용카드, 12:실시간계좌이체, 32:마일리지

Example: 32
dateSelectstringOptional

기간유형

Example: all
Responses
200

성공

*/*
stringOptional
post/v1/payment/paymentDetailsMgmt/refundMileagePayment
POST /api/bo/v1/payment/paymentDetailsMgmt/refundMileagePayment HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 299

[
  {
    "searchStartDt": "2099-01-01",
    "searchEndDt": "2099-01-31",
    "ordNo": "20230809O000001",
    "payGbCd": 10,
    "payStatCd": 12,
    "payStatCdList": [
      12,
      22
    ],
    "ordMediaCd": 30,
    "payNo": 1,
    "uprPayNo": 1,
    "ordDtlGbCd": 10,
    "claimNo": "20230809C000001",
    "rfdAmt": 1000,
    "payAmt": 1000,
    "mbrNo": 100001311,
    "payWayCd": 32,
    "dateSelect": "all"
  }
]
200

성공

text

마일리지 결제내역 조회

get

기능설명

  • 마일리지로 결제한 내역들을 조회합니다.


상세설명

  • [BO] 주문/결제 > 결제/모니터링 관리 > 마일리지 결제내역 조회 페이지에서 조회 버튼 클릭 시 호출됩니다.

  • **결제일자(시작일자, 종료일자)**는 필수 조회 조건입니다.

  • 주문번호, 결제번호, 결제구분, 결제상태, 주문매체는 선택 조회 조건입니다.

  • 조회결과는 결제번호, 결제수단, 결제구분, 결제상태, 주문매체, 주문번호, 회원명, 결제/환불완료일시, 결제금액 입니다.


수정번호

  • Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가

  • Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v1/payment/paymentDetailsMgmt/getMileagePaymentList
GET /api/bo/v1/payment/paymentDetailsMgmt/getMileagePaymentList?mileagePaymentRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

성공

{
  "totalCount": 1,
  "payloads": [
    {
      "payGbCd": 10,
      "payGbNm": "결제",
      "payWayCd": 32,
      "payWayNm": "마일리지",
      "payStatCd": 12,
      "payStatNm": "결제완료",
      "ordMediaCd": 30,
      "ordMediaNm": "모바일웹",
      "ordNo": "20990101O000001",
      "siteNm": "플래티어닷컴",
      "ordManNm": "홍길동",
      "mbrNo": 1,
      "payFnshDtm": "2023-07-20 08:20:24.000000",
      "rfdPsbAmt": 1000,
      "payAmt": 1000,
      "rfdAmt": 1000,
      "sctnCnclPsbYn": "Y",
      "payNo": 1,
      "uprPayNo": 1,
      "ordDtlGbCd": 10,
      "claimNo": "20990101C000001",
      "loginId": "회원ID"
    }
  ]
}

현금 결제내역 조회

get

기능 설명

  • 현금 결제내역을 조회하는 API 입니다.


상세 내용

  • 실시간계좌이체 결제내역과 총 카운트를 응답합니다.


수정번호

  • Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가

  • Release v2.00_240530: 날짜조회 쿼리 변경

  • Release v2.00_240925: PG사 검색조건 추가

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v1/payment/paymentDetailsMgmt/getCashPaymentList
GET /api/bo/v1/payment/paymentDetailsMgmt/getCashPaymentList?cashPaymentRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalCount": 1,
  "payloads": [
    {
      "payGbNm": "결제",
      "payWayNm": "실시간계좌이체",
      "payStatNm": "결제완료",
      "ordMediaNm": "모바일웹",
      "ordNo": "20230831O000001",
      "siteNm": "플래티어닷컴",
      "ordManNm": "홍길동",
      "payFnshDtm": "2023-08-31 00:00:00",
      "payAmt": 10000,
      "bankNm": "우리은행",
      "pgGbNm": "이니시스",
      "payNo": 1000,
      "dptFcstDt": "2023-09-01",
      "mbrNo": 1,
      "loginId": "회원ID"
    }
  ]
}

신용카드 결제내역 조회

get

기능 설명

  • 신용카드 결제내역을 조회하는 API 입니다.


상세 설명

  • 신용카드 결제내역과 총 카운트를 응답합니다.


수정번호

  • Release v2.00_240425: 사이트 검색조건 및 결과컬럼 추가

  • Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v1/payment/paymentDetailsMgmt/getCardPaymentList
GET /api/bo/v1/payment/paymentDetailsMgmt/getCardPaymentList?cardPaymentRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalCount": 1,
  "payloads": [
    {
      "payGbNm": "결제",
      "payWayNm": "신용카드",
      "payStatNm": "결제완료",
      "ordMediaNm": "모바일웹",
      "ordNo": "20230831O000001",
      "siteNm": "플래티어닷컴",
      "ordManNm": "홍길동",
      "payFnshDtm": "2023-08-31 00:00:00",
      "payAmt": 10000,
      "acqrCd": 101,
      "acqrNm": "BC카드",
      "divMonCnt": 1,
      "aprvNo": "000000",
      "aprvDtm": "2023-08-31",
      "pgGbNm": "이니시스",
      "payNo": 1000,
      "loginId": "회원ID",
      "mbrNo": 1
    }
  ]
}

마지막 업데이트