Customer Compensation Payment Status
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 DateHandler Search Type: 1: Member Login ID, 2: Member NameReceiver/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
periodTypestringOptionalExample:
Period Search Type
0startDatestring · dateOptionalExample:
Start Date
2023-09-07endDatestring · dateOptionalExample:
End Date
2023-09-14cpnsTypNostringOptionalExample:
Compensation Type No.
10053cpnsMeanCdstring · enumOptionalExample:
Compensation Method Code (CS019)
10Possible values: mbrTypestringOptionalExample:
Handler Search Type
2loginIdstringOptionalExample:
Member Login ID
kdh9110mbrNmstringOptionalExample:
Member Name
김동혁userTypestringOptionalExample:
Receiver/Handler Type
1userNmstringOptional
Person in Charge Name
userIdstringOptionalExample:
Person in Charge ID
x2beeccccnNostringOptionalExample:
Consultation No.
10014155siteNostringOptionalExample:
Site No.
1Responses
200
Success
*/*
totalCountinteger · int32Optional
900
Business processing error details
*/*
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