> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/payment-bo-api/payment-history-lookup.md).

# Payment History Lookup

## Request Mileage Payment Refund

> &#x20;  \## Function Description\
> &#x20;  \* Function to process refunds for mileage refund records in Refund Requested status.\
> &#x20;  \---\
> &#x20;  \## Detailed Description\
> &#x20;  \* Called when the Refund Complete button is clicked on the \[BO] Order/Payment > Payment/Monitoring Management > Mileage Payment History page.\
> &#x20;  \* Used when an error occurs during a combined-payment refund, so that the PG payment was refunded but the mileage was not.\
> &#x20;  \* Requires \*\*Payment Type Code (OM012): Refund (20), Payment Method Code (OM013): Mileage (32), Payment Status Code (OM014): Refund Requested (21)\*\*.\
> &#x20;  \---\
> &#x20;  \## Revision History\
> &#x20;  \* Release v2.00\_240425: Added site search condition and result columns<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MileagePaymentRequest":{"type":"object","description":"Search Mileage Payment History Request","properties":{"searchStartDt":{"type":"string","format":"date","description":"Payment Date (Start)"},"searchEndDt":{"type":"string","format":"date","description":"Payment Date (End)"},"ordNo":{"type":"string","description":"Order No."},"payGbCd":{"type":"string","description":"Payment Type Code (OM012) 10: Payment, 20: Refund"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled"},"payStatCdList":{"type":"array","description":"Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled","items":{"type":"string"}},"ordMediaCd":{"type":"string","description":"Order Media Code (OM007) 10: Phone Consultation (CC), 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"payNo":{"type":"string","description":"Payment Number"},"uprPayNo":{"type":"string","description":"Parent Payment No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Type Code (OM003) 10: General Order, 11: Order Cancellation, 20: General Return, 21: Return Cancellation, 30: Exchange Order, 31: Exchange Cancellation, 40: Exchange Return"},"claimNo":{"type":"string","description":"Claim No."},"rfdAmt":{"type":"number","description":"Refund Request Amount"},"payAmt":{"type":"number","description":"Payment Amount"},"mbrNo":{"type":"string","description":"Member No."},"payWayCd":{"type":"string","description":"Payment Method Code (OM013) 11: Credit Card, 12: Real-time Account Transfer, 32: Mileage"},"dateSelect":{"type":"string","description":"Period Type"}}}}},"paths":{"/v1/payment/paymentDetailsMgmt/refundMileagePayment":{"post":{"tags":["Payment History Lookup"],"summary":"Request Mileage Payment Refund","description":"   ## Function Description\n   * Function to process refunds for mileage refund records in Refund Requested status.\n   ---\n   ## Detailed Description\n   * Called when the Refund Complete button is clicked on the [BO] Order/Payment > Payment/Monitoring Management > Mileage Payment History page.\n   * Used when an error occurs during a combined-payment refund, so that the PG payment was refunded but the mileage was not.\n   * Requires **Payment Type Code (OM012): Refund (20), Payment Method Code (OM013): Mileage (32), Payment Status Code (OM014): Refund Requested (21)**.\n   ---\n   ## Revision History\n   * Release v2.00_240425: Added site search condition and result columns\n","operationId":"refundMileagePayment","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MileagePaymentRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}}}}}}}
```

## Search Mileage Payment History

> &#x20; \## Function Description\
> &#x20; \* Retrieves the history of payments made with mileage.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Called when the Search button is clicked on the \[BO] Order/Payment > Payment/Monitoring Management > Mileage Payment History page.\
> &#x20; \* \*\*Payment Date (start date, end date)\*\* is a required search condition.\
> &#x20; \* \*\*Order No., Payment No., Payment Type, Payment Status, Order Media\*\* are optional search conditions.\
> &#x20; \* The search results are \*\*Payment No., Payment Method, Payment Type, Payment Status, Order Media, Order No., Member Name, Payment/Refund Completion Date/Time, Payment Amount\*\*.\
> &#x20; \---\
> &#x20; \## Revision History\
> &#x20; \* Release v2.00\_240425: Added site search condition and result columns\
> &#x20; \* Release v2.00\_240530: Changed the date search query<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MileagePaymentRequest":{"type":"object","description":"Search Mileage Payment History Request","properties":{"searchStartDt":{"type":"string","format":"date","description":"Payment Date (Start)"},"searchEndDt":{"type":"string","format":"date","description":"Payment Date (End)"},"ordNo":{"type":"string","description":"Order No."},"payGbCd":{"type":"string","description":"Payment Type Code (OM012) 10: Payment, 20: Refund"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled"},"payStatCdList":{"type":"array","description":"Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled","items":{"type":"string"}},"ordMediaCd":{"type":"string","description":"Order Media Code (OM007) 10: Phone Consultation (CC), 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"payNo":{"type":"string","description":"Payment Number"},"uprPayNo":{"type":"string","description":"Parent Payment No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Type Code (OM003) 10: General Order, 11: Order Cancellation, 20: General Return, 21: Return Cancellation, 30: Exchange Order, 31: Exchange Cancellation, 40: Exchange Return"},"claimNo":{"type":"string","description":"Claim No."},"rfdAmt":{"type":"number","description":"Refund Request Amount"},"payAmt":{"type":"number","description":"Payment Amount"},"mbrNo":{"type":"string","description":"Member No."},"payWayCd":{"type":"string","description":"Payment Method Code (OM013) 11: Credit Card, 12: Real-time Account Transfer, 32: Mileage"},"dateSelect":{"type":"string","description":"Period Type"}}},"RealGridListResponseMileagePaymentResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/MileagePaymentResponse"}}}},"MileagePaymentResponse":{"type":"object","description":"Mileage Payment History Inquiry Response","properties":{"payGbCd":{"type":"string","description":"Payment Classification Code (OM012)"},"payGbNm":{"type":"string","description":"Payment Classification Code Name (OM012)"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayNm":{"type":"string","description":"Payment Method Code Name (OM013)"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014)"},"payStatNm":{"type":"string","description":"Payment Status Code Name (OM014)"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"ordMediaNm":{"type":"string","description":"Order Media Code Name (OM007)"},"ordNo":{"type":"string","description":"Order No."},"siteNm":{"type":"string","description":"Site Name"},"ordManNm":{"type":"string","description":"Member Name"},"mbrNo":{"type":"string","description":"Member No."},"payFnshDtm":{"type":"string","format":"date-time","description":"Payment/Refund Completion Date"},"rfdPsbAmt":{"type":"integer","format":"int64","description":"Refundable Amount"},"payAmt":{"type":"integer","format":"int64","description":"Payment Amount"},"rfdAmt":{"type":"integer","format":"int64","description":"Refund Request Amount"},"sctnCnclPsbYn":{"type":"string","description":"Partial Cancellation Availability Status"},"payNo":{"type":"string","description":"Payment Number"},"uprPayNo":{"type":"string","description":"Parent Payment No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Type Code (OM003)"},"claimNo":{"type":"string","description":"Claim No."},"loginId":{"type":"string","description":"plateerId"}}}}},"paths":{"/v1/payment/paymentDetailsMgmt/getMileagePaymentList":{"get":{"tags":["Payment History Lookup"],"summary":"Search Mileage Payment History","description":"  ## Function Description\n  * Retrieves the history of payments made with mileage.\n  ---\n  ## Detailed Description\n  * Called when the Search button is clicked on the [BO] Order/Payment > Payment/Monitoring Management > Mileage Payment History page.\n  * **Payment Date (start date, end date)** is a required search condition.\n  * **Order No., Payment No., Payment Type, Payment Status, Order Media** are optional search conditions.\n  * The search results are **Payment No., Payment Method, Payment Type, Payment Status, Order Media, Order No., Member Name, Payment/Refund Completion Date/Time, Payment Amount**.\n  ---\n  ## Revision History\n  * Release v2.00_240425: Added site search condition and result columns\n  * Release v2.00_240530: Changed the date search query\n","operationId":"getMileagePaymentList","parameters":[{"name":"mileagePaymentRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/MileagePaymentRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseMileagePaymentResponse"}}}}}}}}}
```

## Search Cash Payment History

> \## Function Description\
> \- API that retrieves the cash payment history.\
> \---\
> \## Detailed Description\
> \- Returns the real-time account transfer payment history and the total count.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site search condition and result columns\
> \* Release v2.00\_240530: Changed the date search query\
> \* Release v2.00\_240925: Added PG company search condition<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CashPaymentRequest":{"type":"object","properties":{"searchStartDt":{"type":"string","format":"date","description":"Search Start Date (Payment Date)"},"searchEndDt":{"type":"string","format":"date","description":"Search End Date (Payment Date)"},"ordNo":{"type":"string","description":"Order No."},"pgCd":{"type":"string","description":"PG Classification Code (OM030)"},"bankCd":{"type":"string","description":"Bank Code (OM026)"},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012) 10: Payment, 20: Refund"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled"},"ordMediaCd":{"type":"string","description":"Order Media Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013) 12: Real-time Account Transfer, 13: Virtual Account"},"dateSelect":{"type":"string","description":"Period Type"}}},"RealGridListResponseCashPaymentResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CashPaymentResponse"}}}},"CashPaymentResponse":{"type":"object","properties":{"payGbNm":{"type":"string","description":"Payment Classification Code Name (OM012)"},"payWayNm":{"type":"string","description":"Payment Method Code Name (OM013)"},"payStatNm":{"type":"string","description":"Payment Status Code Name (OM014)"},"ordMediaNm":{"type":"string","description":"Order Media Code Name (OM007)"},"ordNo":{"type":"string","description":"Order No."},"siteNm":{"type":"string","description":"Site Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"payFnshDtm":{"type":"string","format":"date-time","description":"Payment/Refund Completion Date"},"payAmt":{"type":"integer","format":"int64","description":"Payment Amount"},"bankNm":{"type":"string","description":"Bank Name (OM026)"},"pgGbNm":{"type":"string","description":"PG Company Name (OM030)"},"payNo":{"type":"string","description":"Payment Number"},"dptFcstDt":{"type":"string","description":"Payment Due Date"},"mbrNo":{"type":"string","description":"Member No."},"loginId":{"type":"string","description":"plateerId"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/paymentDetailsMgmt/getCashPaymentList":{"get":{"tags":["Payment History Lookup"],"summary":"Search Cash Payment History","description":"## Function Description\n- API that retrieves the cash payment history.\n---\n## Detailed Description\n- Returns the real-time account transfer payment history and the total count.\n---\n## Revision History\n* Release v2.00_240425: Added site search condition and result columns\n* Release v2.00_240530: Changed the date search query\n* Release v2.00_240925: Added PG company search condition\n","operationId":"getCashPaymentList","parameters":[{"name":"cashPaymentRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CashPaymentRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCashPaymentResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Search Credit Card Payment History

> \## Function Description\
> \- API that retrieves the credit card payment history.\
> \---\
> \## Detailed Description\
> \- Returns the credit card payment history and the total count.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site search condition and result columns\
> \* Release v2.00\_240530: Changed the date search query<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CardPaymentRequest":{"type":"object","properties":{"searchStartDt":{"type":"string","format":"date","description":"Search Start Date (Payment Date)"},"searchEndDt":{"type":"string","format":"date","description":"Search End Date (Payment Date)"},"ordNo":{"type":"string","description":"Order No."},"aprvNo":{"type":"string","description":"Approval No."},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012) 10: Payment, 20: Refund"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled"},"ordMediaCd":{"type":"string","description":"Order Media Code (OM007) 20: PC, 30: Mobile Web, 40: Android App, 50: iOS App"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013) 11: Credit Card, 12: Real-time Account Transfer, 32: Mileage"},"dateSelect":{"type":"string","description":"Period Type"}}},"RealGridListResponseCardPaymentResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CardPaymentResponse"}}}},"CardPaymentResponse":{"type":"object","properties":{"payGbNm":{"type":"string","description":"Payment Classification Code Name (OM012)"},"payWayNm":{"type":"string","description":"Payment Method Code Name (OM013)"},"payStatNm":{"type":"string","description":"Payment Status Code Name (OM014)"},"ordMediaNm":{"type":"string","description":"Order Medium Name (OM007)"},"ordNo":{"type":"string","description":"Order No."},"siteNm":{"type":"string","description":"Site Name"},"ordManNm":{"type":"string","description":"Orderer Name"},"payFnshDtm":{"type":"string","format":"date-time","description":"Payment/Refund Completion Date"},"payAmt":{"type":"integer","format":"int64","description":"Payment Amount"},"acqrCd":{"type":"string","description":"Purchasing Company Code (OM028)"},"acqrNm":{"type":"string","description":"Acquirer Code Name (OM028)"},"divMonCnt":{"type":"integer","format":"int32","description":"Installment Months"},"aprvNo":{"type":"string","description":"Approval No."},"aprvDtm":{"type":"string","format":"date","description":"Approval Date/Time"},"pgGbNm":{"type":"string","description":"PG Company Name"},"payNo":{"type":"string","description":"Payment Number"},"loginId":{"type":"string","description":"plateerId"},"mbrNo":{"type":"string","description":"Member No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/payment/paymentDetailsMgmt/getCardPaymentList":{"get":{"tags":["Payment History Lookup"],"summary":"Search Credit Card Payment History","description":"## Function Description\n- API that retrieves the credit card payment history.\n---\n## Detailed Description\n- Returns the credit card payment history and the total count.\n---\n## Revision History\n* Release v2.00_240425: Added site search condition and result columns\n* Release v2.00_240530: Changed the date search query\n","operationId":"getCardPaymentList","parameters":[{"name":"cardPaymentRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CardPaymentRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCardPaymentResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```