For the complete documentation index, see llms.txt. This page is also available as Markdown.

Customer Compensation Payment Status

Retrieve Customer Compensation Payment Status List

get

API Description

  • Retrieves the customer compensation payment status list.


Detailed Description

  • Retrieves the customer compensation payment status list based on the receipt/payment date.


Code Reference

  • Period Search Type: 0: Payment Date, 1: Receipt Date

  • Handler Search Type: 1: Member Login ID, 2: Member Name

  • Receiver/Handler Type: 1: Receiver, 2: Payer


Revision History

  • Release v2.00_240613: Improved period search conditions

  • Release v2.01_240903: Changed to V2 RealGridResponse

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
periodTypestringOptional

Period Search Type

Example: 0
startDatestring · dateOptional

Start Date

Example: 2023-09-07
endDatestring · dateOptional

End Date

Example: 2023-09-14
cpnsTypNostringOptional

Compensation Type No.

Example: 10053
cpnsMeanCdstring · enumOptional

Compensation Method Code (CS019)

Example: 10Possible values:
mbrTypestringOptional

Handler Search Type

Example: 2
loginIdstringOptional

Member Login ID

Example: kdh9110
mbrNmstringOptional

Member Name

Example: 김동혁
userTypestringOptional

Receiver/Handler Type

Example: 1
userNmstringOptional

Person in Charge Name

userIdstringOptional

Person in Charge ID

Example: x2beecc
ccnNostringOptional

Consultation No.

Example: 10014155
siteNostringOptional

Site No.

Example: 1
Responses
200

Success

*/*
totalCountinteger · int32Optional
get/v2/customerservice/customerCompensPayMgmt/getCustomerCompensPayList
GET /api/bo/v2/customerservice/customerCompensPayMgmt/getCustomerCompensPayList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalCount": 1,
  "payloads": [
    {
      "custCpnsAplyNo": "text",
      "accpDtm": "text",
      "accpCont": "text",
      "cpnsAprvStatCd": "text",
      "cpnsAprvStatNm": "text",
      "cpnsPayStatCd": "text",
      "cpnsPayStatNm": "text",
      "cpnsTypNm": "text",
      "cpnsMeanCd": "text",
      "cpnsMeanNm": "text",
      "rspnGbCd": "text",
      "rspnGbNm": "text",
      "cpnsAmtNo": "text",
      "maxPayLim": "text",
      "overAmt": "text",
      "ccnNo": "text",
      "ordNo": "text",
      "goodsNo": "text",
      "goodsNm": "text",
      "itmNm": "text",
      "loginId": "text",
      "mbrNm": "text",
      "mbrNo": "text",
      "entrNm": "text",
      "acptmnId": "text",
      "aprvDtm": "text",
      "aprmnId": "text",
      "retnDtm": "text",
      "retnProcmnId": "text",
      "payDtm": "text",
      "paymnId": "text",
      "payCont": "text",
      "payReqMemo": "text",
      "payBankCd": "text",
      "payActnNo": "text",
      "payDepositorNm": "text",
      "siteNm": "text"
    }
  ]
}

Last updated