Refund

Complete Original Payment Refund

post

Function Description

• Processes completion of 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

    • Can be processed if 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 of the API call and verifies whether completion is possible.

    • The order detail table's order history status code (OM005) value is changed to Return Completed (37) (including gift), and the order completion datetime (ordFnshDtm) is updated.

    • The order delivery information table's delivery completion datetime (deliFnshDtm) is updated.

    • The stock of the coupon used at order time and the order product (including gift) is restored. However, if the order detail's exchange-in-progress-return status (exchMidRtnYn) value is (Y), it is excluded from stock restoration.

    • The refund process is carried out.

    • A notification is sent to the customer after return completion processing (email/notification message/notification inbox).

    • A processing history is created after return completion processing.

• Delivers the result after all target claims have been fully refunded.

---

Notes

• Processes the original payment refund completion when Claim Business Type (claimBusinessType) is Return Completed (22).

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · RefundBundleApproMgmtCUDSaveRequest[]

Original Order Refund Completion Processing Request DTO

claimBusinessTypestring · enumRequired

ClaimBusiness (Claim Business Type) * 11 : Order Cancellation * 20 : Return Receipt * 21 : Return Cancellation * 30 : Exchange Receipt * 31 : Exchange Cancellation * 22 : Return Completed * 23 : Return Not Possible * 24 : Exchange Return * 25 : Return On Hold

Default: 20Example: 11Possible values:

ordNostringRequired

Order No.

Example: 20230808O007404

ordMediaCdstring · enumRequired

Order Channel Code (OM007) 10 : Phone Consultation (CC) , 20 : PC , 30 : Mobile Web , 40 : Android App , 50 : iOS App , 60 : Subscription Order

Default: 20Example: 20Possible values:

systemTypestring · enumRequired

SYSTEM (System Type) * 10 : FO * 20 : BO

Default: 20Example: 10Possible values:

claimNostringOptional

Claim No.

Example: 20230801C008072

Responses

200

Success

*/*

Original Order Refund Completion Processing Result DTO

claimNostringOptional

Claim No.

Example: 20230101C000001

resultCodestringOptional

Result Code

Example: 0000

900

Business processing error details

*/*

post/v1/payment/saveRefundBundleApproMgmt

POST /api/order/v1/payment/saveRefundBundleApproMgmt HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 118

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

[
  {
    "claimNo": "20230101C000001",
    "resultCode": "0000"
  }
]

Register Refund Receipt

post

Function Description

• Registers a customer compensation (cash) request from the customer center into the refund information table.

---

Detailed Description

• Registers the requested customer compensation information into the refund information table.

• Returns a refund number if the information is successfully registered in the table.

Header parameters

AuthorizationanyOptional

Access Token

Body

Refund Registration Request DTO

ordNostringOptional

Order No.

mbrNostringRequired

Member No.

mbrNmstringRequired

Member Name

loginIdstringRequired

Login ID

rfdTypCdstringRequired

Refund Type Code (OM023)

rfdPrgsStatCdstringRequired

Refund Progress Status Code (OM024)

rfdBankCdstringRequired

Refund Bank Code (OM026)

rfdActnNostringRequired

Refund Account No.

rfdActnDepositorNmstringRequired

Refund Account Holder

rfdCausCdstringRequired

Refund Reason Code (OM025)

rfdActnCertiYnstringRequired

Refund Account Verification Status

rfdAmtinteger · int64Required

Refund Amount

rfdCmsnAmtinteger · int64Required

Refund Fee Amount

acptmnIdstringRequired

Receiver ID

rfdSmsSndYnstringRequired

Refund SMS Sent Status

Responses

200

Success

*/*

rfdNostringOptional

900

Business processing error details

*/*

post/v1/payment/refundAcceptRegister

POST /api/order/v1/payment/refundAcceptRegister HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "ordNo": "text",
  "mbrNo": "text",
  "mbrNm": "text",
  "loginId": "text",
  "rfdTypCd": "text",
  "rfdPrgsStatCd": "text",
  "rfdBankCd": "text",
  "rfdActnNo": "text",
  "rfdActnDepositorNm": "text",
  "rfdCausCd": "text",
  "rfdActnCertiYn": "text",
  "rfdAmt": 1,
  "rfdCmsnAmt": 1,
  "acptmnId": "text",
  "rfdSmsSndYn": "text"
}

{
  "rfdNo": "text"
}