Payment History Lookup

Request Mileage Payment Refund

post

Function Description

Function to process refunds for mileage refund records in Refund Requested status.

Detailed Description

Called when the Refund Complete button is clicked on the [BO] Order/Payment > Payment/Monitoring Management > Mileage Payment History page.
Used when an error occurs during a combined-payment refund, so that the PG payment was refunded but the mileage was not.
Requires Payment Type Code (OM012): Refund (20), Payment Method Code (OM013): Mileage (32), Payment Status Code (OM014): Refund Requested (21).

Revision History

Release v2.00_240425: Added site search condition and result columns

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · MileagePaymentRequest[]

Search Mileage Payment History Request

searchStartDtstring · dateOptional

Payment Date (Start)

Example: 2099-01-01

searchEndDtstring · dateOptional

Payment Date (End)

Example: 2099-01-31

ordNostringOptional

Order No.

Example: 20230809O000001

payGbCdstringOptional

Payment Type Code (OM012) 10: Payment, 20: Refund

Example: 10

payStatCdstringOptional

Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled

Example: 12

payStatCdListstring[]Optional

Payment Status Code (OM014) 11: Payment Pending, 12: Payment Completed, 13: Payment Cancelled, 21: Refund Received, 22: Refund Completed, 23: Refund Receipt Cancelled

Example: [12,22]

ordMediaCdstringOptional

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

Example: 30

payNostringOptional

Payment Number

Example: 1

uprPayNostringOptional

Parent Payment No.

Example: 1

ordDtlGbCdstringOptional

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

Example: 10

claimNostringOptional

Claim No.

Example: 20230809C000001

rfdAmtnumberOptional

Refund Request Amount

Example: 1000

payAmtnumberOptional

Payment Amount

Example: 1000

mbrNostringOptional

Member No.

Example: 100001311

payWayCdstringOptional

Payment Method Code (OM013) 11: Credit Card, 12: Real-time Account Transfer, 32: Mileage

Example: 32

dateSelectstringOptional

Period Type

Example: all

Responses

200

Success

*/*

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

Success

text

Search Mileage Payment History

get

Function Description

Retrieves the history of payments made with mileage.

Detailed Description

Called when the Search button is clicked on the [BO] Order/Payment > Payment/Monitoring Management > Mileage Payment History page.
Payment Date (start date, end date) is a required search condition.
Order No., Payment No., Payment Type, Payment Status, Order Media are optional search conditions.
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.

Revision History

Release v2.00_240425: Added site search condition and result columns
Release v2.00_240530: Changed the date search query

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

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

Success

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

Search Cash Payment History

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

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

Search Credit Card Payment History

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

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

PreviousPayment Method Management

NextMerchant Management

Last updated 2 months ago