Refund Management

Update Refund Processing Result

post

Function Description

API that updates the refund processing result.

Detailed Description

Processes the requested refund number list as refund request cancellation.
Only refunds in a status eligible for request cancellation are cancelled.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Success

No content

900

Business processing error details

*/*

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

Complete Original Payment Refund

post

Function Description

Completes the original payment refund in BO.

Detailed Description

Order No. (ordNo), Claim No. (claimNo), Claim Business Type (claimBusinessType), and System Type (systemType) are required.
Processes the target claim as return completed.
- Return Completion Processing Description
  - Processing is possible when the order history type (OM003) value is Return (20) and the order history status (OM005) value is Collection Completed (36).
  - Re-checks the order status at the time the API is called to verify whether the completion processing is possible.
  - The order history status code (OM005) value in the order detail table is changed to Return Completed (37) (including free gifts), and the order completion date/time (ordFnshDtm) is updated.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · RefundBundleApproMgmtCUDSaveRequest[]

Original Order Refund Completion Processing Request DTO

claimBusinessTypestring · enumRequired

Claim Business Type

Example: 20Possible values:

ordNostringRequired

Order No.

Example: 20230808O007404

ordMediaCdstringRequired

Order Channel Code

Example: 20

systemTypestring · enumRequired

System Type

Example: 10Possible values:

claimNostringOptional

Claim No.

Example: 20230808C010663

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

Business processing error details

*/*

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"
    }
  ]
}

Update Manual Refund Processing Excel Upload

post

Function Description

Updates the refund status via the manual refund processing Excel file.

Detailed Description

The update fails if the account information does not match.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Success

No content

900

Business processing error details

*/*

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

Cancel Refund Request

post

Function Description

API that processes the request cancellation of a manual refund record.

Detailed Description

Processes the requested refund number list as refund request cancellation.
Only refunds in a status eligible for request cancellation are cancelled.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

rfdNoListstring[] · min: 1Required

Refund No. List

Responses

200

Success

No content

900

Business processing error details

*/*

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

Check Permission for Manual Refund Processing Excel Download

get

Function Description

API that checks whether the user has permission to download the manual refund processing Excel file.

Detailed Description

Checks whether the user has permission to download the requested refund processing Excel file.
Permission to view ID, name, and account number is required to download the Excel file.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

*/*

booleanOptional

900

Business processing error details

*/*

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

Search Manual Refund History

get

Function Description

API that retrieves the manual refund history.

Detailed Description

If the from value is "ACCEPT", completed refunds are excluded from the search.
If the from value is "COMPLETE", cancelled refunds are excluded from the search.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

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
    }
  ]
}

Download Manual Refund Processing Excel

get

Function Description

API that downloads the Excel file of manual refund processing targets.

Detailed Description

Downloads, as an Excel file, the list of refunds eligible for refund completion processing.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

Business processing error details

*/*

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"
    }
  ]
}

Search Original Order Refund Completion Processing Targets

get

Function Description

     * Retrieves the list of original order refund completion processing targets in BO.
     ---
     ## Detailed Description
     * The order return amount is 0 won or more **((Order Quantity – Cancel Quantity – Return Quantity) * Quantity > 0)**
     * **Order History Type (OM003)** value is **Return (20)**
     * **Order History Status Code (OM005)** value is **Collection Completed (36)**, **Return Completed (37)**
         * In addition to the above (basic) conditions, additional search conditions are applied as specified. (You can select **Order Progress Status (OM005)** as **Collection Completed (36)** or **Return Completed (37)** in the search conditions.)
     ---

Revision History

Release v2.00_240613: Improved period search condition

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

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": 1012345678,
      "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": "환불오류내용"
    }
  ]
}

PreviousPayment BO API

NextInterest Free Installment Guide Management

Last updated 2 months ago