환불관리

환불처리결과 업데이트

post

기능 설명

환불처리결과를 업데이트하는 API입니다.

상세 설명

요청한 환불번호 리스트를 환불접수취소 처리합니다.
접수취소가 가능한 상태의 환불 건만 취소처리 합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v2/payment/refundMgmt/saveRefundProcRslt

POST /api/bo/v2/payment/refundMgmt/saveRefundProcRslt HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "dataList": [
    {
      "rfdNo": 100001101,
      "rfdProcRsltCd": 10
    }
  ]
}

No content

원결제 환불 완료 처리

post

기능 설명

BO에서 원결제 환불 완료 처리합니다.

상세 설명

주문 번호(ordNo), 클레임번호(claimNo), 클레임업무유형(claimBusinessType), **시스템유형(systemType)**은 필수로 있어야 합니다.
대상 클레임을 반품완료처리 합니다.
- 반품완료처리 설명
  - 주문내역구분(OM003) 값이 반품(20) 이고, 주문내역상태(OM005) 값이 회수완료(36) 상태인 경우 처리 가능합니다.
  - API 호출 시점의 주문 상태를 재 확인, 완료 처리 가능 여부를 확인합니다.
  - 주문상세 테이블의 주문내역상태코드(OM005) 값이 반품완료(37) 상태로 변경되며(사은품 포함), 주문완료일시(ordFnshDtm)를 업데이트 합니다.
  - 주문배송정보 테이블의 배송완료일시(deliFnshDtm)를 업데이트 합니다.
  - 주문시 사용되었던 쿠폰과 주문상품(사은품 포함)의 재고가 복원됩니다. 단, 주문상세의 교환중반품여부(exchMidRtnYn)값이 (Y)인 경우 재고 복원대상에서 제외됩니다.
  - 환불 절차를 진행합니다.
  - 반품 완료 처리 후 고객에게 알림을 발송합니다.(이메일/알림톡/알림함)
  - 반품 완료 처리 후 처리 이력을 생성합니다.
대상 클레임들을 모두 환불 완료 후 결과를 전달합니다.

특이 사항

**클레임업무유형(claimBusinessType)**이 **반품완료(22)**인 경우에 원결제 환불 완료 처리합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · RefundBundleApproMgmtCUDSaveRequest[]

원주문 환불완료처리 요청 DTO

claimBusinessTypestring · enumRequired

클레임 업무 유형

Example: 20Possible values:

ordNostringRequired

주문번호

Example: 20230808O007404

ordMediaCdstringRequired

주문매체코드

Example: 20

systemTypestring · enumRequired

시스템유형

Example: 10Possible values:

claimNostringOptional

클레임번호

Example: 20230808C010663

Responses

200

성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

업무처리 오류 내용

*/*

post/v2/payment/refundMgmt/saveRefundBundleApproMgmtList

POST /api/bo/v2/payment/refundMgmt/saveRefundBundleApproMgmtList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

[
  {
    "claimBusinessType": 20,
    "ordNo": "20230808O007404",
    "ordMediaCd": 20,
    "systemType": 10,
    "claimNo": "20230808C010663"
  }
]

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": [
    {
      "claimNo": "20230808C010663",
      "resultCode": "0000"
    }
  ],
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

수기 환불처리 엑셀 업로드 업데이트

post

기능 설명

수기 환불처리 엑셀로 환불상태를 업데이트 합니다.

상세 내용

계좌정보가 다르면 업데이트에 실패합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v2/payment/refundMgmt/refundExcelUpload

POST /api/bo/v2/payment/refundMgmt/refundExcelUpload HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "excelDataList": [
    {
      "rfdNo": 100001101,
      "ordNo": "20230710O001192",
      "loginId": "x2bee",
      "mbrNm": "홍길동",
      "rfdTypNm": "주문환불",
      "rfdPrgsStatNm": "환불접수",
      "rfdBankNm": "우리은행",
      "rfdActnNo": 100000000000,
      "rfdActnDepositorNm": "홍길동",
      "rfdCausNm": 10,
      "rfdAmt": 10000,
      "acptmnId": "x2admin",
      "acptmnNm": "홍길동",
      "accpDtm": "yyyy-MM-dd HH:mm:ss",
      "rfdProcRsltNm": "미처리"
    }
  ]
}

No content

환불접수취소

post

기능 설명

수기 환불내역을 접수취소 처리하는 API입니다.

상세 설명

요청한 환불번호 리스트를 환불접수취소 처리합니다.
접수취소가 가능한 상태의 환불 건만 취소처리 합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

rfdNoListstring[] · min: 1Required

환불번호리스트

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v2/payment/refundMgmt/cancelRefundAccept

POST /api/bo/v2/payment/refundMgmt/cancelRefundAccept HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "rfdNoList": [
    "text"
  ]
}

No content

수기 환불처리 엑셀 다운로드 권한 체크

get

기능 설명

수기 환불처리 엑셀 다운로드 권한이 있는지 체크하는 API입니다.

상세 내용

요청한 환불처리 엑셀 다운로드 권한이 있는지 확인합니다.
엑셀 다운로드를 위해선 ID, 이름, 계좌번호 조회 권한이 있어야 합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

성공

*/*

booleanOptional

900

업무처리 오류 내용

*/*

get/v2/payment/refundMgmt/hasRefundExcelDownloadPermission

GET /api/bo/v2/payment/refundMgmt/hasRefundExcelDownloadPermission HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

수기 환불내역 조회

get

기능 설명

수기 환불내역을 조회하는 API입니다.

상세 설명

from 값이 "ACCEPT"일 경우 환불완료 건은 조회에서 제외됩니다.
from 값이 "COMPLETE"일 경우 환불취소 건은 조회에서 제외됩니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/payment/refundMgmt/getRefundMgmtList

GET /api/bo/v2/payment/refundMgmt/getRefundMgmtList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "accpDtm": "2023-09-01 00:00:00",
      "fnshDtm": "2023-09-01 00:00:00",
      "rfdPrgsStatCd": 10,
      "rfdPrgsStatCdNm": "환불접수",
      "ordNo": "20230831O000001",
      "mbrNo": 100000001,
      "loginId": "x2admin",
      "mbrNm": "어드민",
      "rfdBankCd": 104,
      "rfdBankCdNm": "우리은행",
      "rfdActnNo": 100000000000,
      "rfdActnDepositorNm": "어드민",
      "rfdAmt": 10000,
      "rfdCausCd": 10,
      "rfdCausCdNm": "보상금환불",
      "fnshmnId": "x2admin",
      "fnshmnNm": "어드민",
      "acptmnId": "x2admin",
      "acptmnNm": "어드민",
      "rfdProcRsltCd": 10,
      "rfdProcRsltCdNm": "미처리",
      "rfdNo": 100000001,
      "originRfdProcRsltCd": 10
    }
  ]
}

수기 환불처리 엑셀 다운로드

get

기능 설명

수기 환불처리 대상 엑셀을 다운로드 하는 API입니다.

상세 내용

환불완료 처리가 가능한 환불목록을 엑셀로 다운로드합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

업무처리 오류 내용

*/*

get/v2/payment/refundMgmt/getRefundExcelData

GET /api/bo/v2/payment/refundMgmt/getRefundExcelData?indiInfoLog=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

원주문 환불완료처리대상 목록 조회

get

기능 설명

     * BO에서 원주문 환불완료처리대상 목록을 조회합니다.
     ---
     ## 상세 설명
     * 주문반품금액이 0원 이상 **((주문수량 – 취소수량 – 반품수량) * 수량 > 0)**
     * **주문내역구분(OM003)** 값이 **반품(20)**
     * **주문내역상태코드(OM005)** 값이 **회수완료(36)**, **반품완료(37)**
         * 위의 조건(기본조건) 외 조회조건에 따라 조회조건에 추가됩니다.(조회 조건 중 **주문진행상태(OM005)**를 **회수완료(36)**, **반품완료(37)**로 선택할 수 있습니다.)
     ---

수정번호

Release v2.00_240613: 기간 검색 조건 개선

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/payment/refundMgmt/getRefundBundleApproMgmtList

GET /api/bo/v2/payment/refundMgmt/getRefundBundleApproMgmtList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230101O000001",
      "loginId": "id001",
      "ordManNm": "홍길동",
      "cellNo": "01012345678",
      "ordMediaCd": 20,
      "returnAccpDtm": "2023-01-01 00:00:00",
      "claimNo": "20230101C000000",
      "ordPrc": 25000,
      "ordDtlStatCd": 36,
      "ordDtlStatCdNm": "회수완료",
      "pgAprvCd": 21,
      "pgAprvCdNm": "환불접수",
      "rfdFnshDtm": "2023-01-01 00:00:00",
      "rfdPayStatCd": 12,
      "rfdPayStatCdNm": "결제완료",
      "pgGbCd": 10,
      "pgGbCdNm": "이니시스",
      "payWayCd": 10,
      "payWayCdNm": "신용카드",
      "cancelAmt": 25000,
      "mainCancelAmt": 25000,
      "milgCancelAmt": 1000,
      "rfdAmt": 1000,
      "errorConts": "환불오류내용"
    }
  ]
}

이전결제(Payment) BO API

다음무이자할부 안내 관리

마지막 업데이트 5개월 전