> 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/cs-bo-api/customer-compensation-payment-status.md).

# Customer Compensation Payment Status

## Retrieve Customer Compensation Payment Status List

> \## 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<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":{"RealGridListResponseCsCustomerCompensResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CsCustomerCompensResponse"}}}},"CsCustomerCompensResponse":{"type":"object","properties":{"custCpnsAplyNo":{"type":"string"},"accpDtm":{"type":"string"},"accpCont":{"type":"string"},"cpnsAprvStatCd":{"type":"string"},"cpnsAprvStatNm":{"type":"string"},"cpnsPayStatCd":{"type":"string"},"cpnsPayStatNm":{"type":"string"},"cpnsTypNm":{"type":"string"},"cpnsMeanCd":{"type":"string"},"cpnsMeanNm":{"type":"string"},"rspnGbCd":{"type":"string"},"rspnGbNm":{"type":"string"},"cpnsAmtNo":{"type":"string"},"maxPayLim":{"type":"string"},"overAmt":{"type":"string"},"ccnNo":{"type":"string"},"ordNo":{"type":"string"},"goodsNo":{"type":"string"},"goodsNm":{"type":"string"},"itmNm":{"type":"string"},"loginId":{"type":"string"},"mbrNm":{"type":"string"},"mbrNo":{"type":"string"},"entrNm":{"type":"string"},"acptmnId":{"type":"string"},"aprvDtm":{"type":"string"},"aprmnId":{"type":"string"},"retnDtm":{"type":"string"},"retnProcmnId":{"type":"string"},"payDtm":{"type":"string"},"paymnId":{"type":"string"},"payCont":{"type":"string"},"payReqMemo":{"type":"string"},"payBankCd":{"type":"string"},"payActnNo":{"type":"string"},"payDepositorNm":{"type":"string"},"siteNm":{"type":"string"}}},"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":{"/v2/customerservice/customerCompensPayMgmt/getCustomerCompensPayList":{"get":{"tags":["Customer Compensation Payment Status"],"summary":"Retrieve Customer Compensation Payment Status List","description":"## API Description\n* Retrieves the customer compensation payment status list.\n---\n## Detailed Description\n* Retrieves the customer compensation payment status list based on the receipt/payment date.\n---\n## Code Reference\n* ```Period Search Type```: 0: Payment Date, 1: Receipt Date\n* ```Handler Search Type```: 1: Member Login ID, 2: Member Name\n* ```Receiver/Handler Type```: 1: Receiver, 2: Payer\n---\n## Revision History\n* Release v2.00_240613: Improved period search conditions\n* Release v2.01_240903: Changed to V2 RealGridResponse\n","operationId":"getCustomerCompensPayList","parameters":[{"name":"periodType","in":"query","description":"Period Search Type","required":false,"schema":{"type":"string","description":"Period Search Type"}},{"name":"startDate","in":"query","description":"Start Date","required":false,"schema":{"type":"string","format":"date","description":"Start Date"}},{"name":"endDate","in":"query","description":"End Date","required":false,"schema":{"type":"string","format":"date","description":"End Date"}},{"name":"cpnsTypNo","in":"query","description":"Compensation Type No.","required":false,"schema":{"type":"string","description":"Compensation Type No."}},{"name":"cpnsMeanCd","in":"query","description":"Compensation Method Code (CS019)","required":false,"schema":{"type":"string","description":"Compensation Method Code (CS019)","enum":["COUPON","CASH","MILEAGE","GIFT"]}},{"name":"mbrType","in":"query","description":"Handler Search Type","required":false,"schema":{"type":"string","description":"Handler Search Type"}},{"name":"loginId","in":"query","description":"Member Login ID","required":false,"schema":{"type":"string","description":"Member Login ID"}},{"name":"mbrNm","in":"query","description":"Member Name","required":false,"schema":{"type":"string","description":"Member Name"}},{"name":"userType","in":"query","description":"Receiver/Handler Type","required":false,"schema":{"type":"string","description":"Receiver/Handler Type"}},{"name":"userNm","in":"query","description":"Person in Charge Name","required":false,"schema":{"type":"string","description":"Person in Charge Name"}},{"name":"userId","in":"query","description":"Person in Charge ID","required":false,"schema":{"type":"string","description":"Person in Charge ID"}},{"name":"ccnNo","in":"query","description":"Consultation No.","required":false,"schema":{"type":"string","description":"Consultation No."}},{"name":"siteNo","in":"query","description":"Site No.","required":false,"schema":{"type":"string","description":"Site No."}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCsCustomerCompensResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````