> 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/settlement-bo-api/pg-settlement-reconciliation.md).

# PG Settlement Reconciliation

## Retrieve PG Settlement Comparison List

> \## Function Description\
> \* Retrieves the PG settlement comparison list.\
> \---\
> \## Detailed Description\
> \* Retrieves the PG settlement comparison content matching the conditions passed from the screen.\
> \* Retrieves the amount information for EC system approval/cancellation and PG company approval/cancellation cases on the search date, and the sum of the difference between the expected deposit amount and the deposit amount for both approval/cancellation cases.\
> \---\
> \## Code Reference\
> \* \`\`\`Search Date Type (searchDateType)\`\`\` : aprvDt: Search by approval date, dptDt: Search by deposit date\
> \---\
> \## Revision History\
> \* Release v1.04\_231120: Initial development of PG settlement comparison<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":{"PgAdjCoprRequest":{"type":"object","description":"Retrieve PG Settlement Comparison List Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"searchDateType":{"type":"string","description":"Search Date Basis Type"},"startDate":{"type":"string","format":"date","description":"Search Start Date"},"endDate":{"type":"string","format":"date","description":"Search End Date"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction Number"},"dptCfmYn":{"type":"string","description":"Deposit Confirmation Status"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"ordNo":{"type":"string","description":"Order No."},"termlId":{"type":"string","description":"Terminal ID"},"payStatCd":{"type":"string","description":"Payment Type"}}},"RealGridListResponsePgAdjCoprResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PgAdjCoprResponse"}}}},"PgAdjCoprResponse":{"type":"object","description":"Retrieve PG Settlement Comparison Response DTO","properties":{"infLogSeq":{"type":"string","description":"Interface Log Sequence No."},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"pgGbNm":{"type":"string","description":"PG Type Name (OM030)"},"mersEtcGbNm":{"type":"string","description":"Merchant Other Classification Code Name (OM052)"},"ordNo":{"type":"string","description":"Order No."},"payStatus":{"type":"string","description":"Payment Status Name"},"payWayNm":{"type":"string","description":"Payment Method Name"},"aprvCnclDt":{"type":"string","description":"Approval/Cancellation Date"},"payAmt":{"type":"number","description":"Payment Amount"},"expectedFee":{"type":"integer","format":"int64","description":"Expected Fee"},"expectedDepositAmt":{"type":"integer","format":"int64","description":"Expected Deposit Amount"},"approveAmt":{"type":"integer","format":"int64","description":"PG Approval Amount"},"paymentFee":{"type":"integer","format":"int64","description":"PG Payment Fee"},"depositAmt":{"type":"integer","format":"int64","description":"Deposit Amount"},"dptDt":{"type":"string","description":"Deposit Date"},"etcAdjAmt":{"type":"number","description":"Other Adjustment Amount"},"depositAmtDiff":{"type":"integer","format":"int64","description":"Deposit Amount Difference"},"adjAjstCausConts":{"type":"string","description":"Settlement Adjustment Reason"},"dptCfmYn":{"type":"string","description":"Deposit Confirmation Status"},"dptCfmDtm":{"type":"string","format":"date-time","description":"Deposit Confirmation Date/Time"},"trdNo":{"type":"string","description":"Transaction Number"},"termlId":{"type":"string","description":"Terminal ID"},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012)"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}}},"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/adjust/pgAdjust/getPgAdjustCompareList":{"post":{"tags":["PG Settlement Reconciliation"],"summary":"Retrieve PG Settlement Comparison List","description":"## Function Description\n* Retrieves the PG settlement comparison list.\n---\n## Detailed Description\n* Retrieves the PG settlement comparison content matching the conditions passed from the screen.\n* Retrieves the amount information for EC system approval/cancellation and PG company approval/cancellation cases on the search date, and the sum of the difference between the expected deposit amount and the deposit amount for both approval/cancellation cases.\n---\n## Code Reference\n* ```Search Date Type (searchDateType)``` : aprvDt: Search by approval date, dptDt: Search by deposit date\n---\n## Revision History\n* Release v1.04_231120: Initial development of PG settlement comparison\n","operationId":"getPgAdjustCompareList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PgAdjCoprRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePgAdjCoprResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Save PG Settlement Comparison Adjustment Reason

> \## Function Description\
> \* Saves the adjustment reason for a PG settlement comparison.\
> \---\
> \## Detailed Description\
> \* Order No., Transaction No., Payment Type Code, Settlement Adjustment Reason Content, and Other Settlement Amount are required.\
> \* If the deposit amount difference is 0 (amounts match), an adjustment reason cannot be registered.\
> \* Only a single record can be registered at a time.\
> \---\
> \## Revision History\
> \* Release v1.04\_231120: Initial development of PG settlement comparison<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":{"PgAjstCoprAjstCausRequest":{"type":"object","description":"PG Settlement Comparison Adjustment Reason Registration Request DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"trdNo":{"type":"string","description":"Transaction Number"},"payGbCd":{"type":"string","description":"Payment Classification Code (OM012)"},"etcAdjAmt":{"type":"number","description":"Other Settlement Amount"},"adjAjstCausConts":{"type":"string","description":"Settlement Adjustment Reason"}}},"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/adjust/pgAdjust/savePgAdjustCompareAjstCaus":{"post":{"tags":["PG Settlement Reconciliation"],"summary":"Save PG Settlement Comparison Adjustment Reason","description":"## Function Description\n* Saves the adjustment reason for a PG settlement comparison.\n---\n## Detailed Description\n* Order No., Transaction No., Payment Type Code, Settlement Adjustment Reason Content, and Other Settlement Amount are required.\n* If the deposit amount difference is 0 (amounts match), an adjustment reason cannot be registered.\n* Only a single record can be registered at a time.\n---\n## Revision History\n* Release v1.04_231120: Initial development of PG settlement comparison\n","operationId":"savePgAdjustCompareAjstCaus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PgAjstCoprAjstCausRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Receive PG Settlement Information

> \## Function Description\
> \* Receives and saves PG settlement information for the selected date and PG type code.\
> \---\
> \## Detailed Description\
> \* Receives the PG company's settlement comparison list information for the given PG type code and search start/end date/time.\
> \* Saves the settlement list information retrieved for PG settlement comparison.\
> \* Cases where the deposit confirmation status is Y cannot be received.\
> \* The received data can be viewed on the PG settlement comparison screen.\
> \---\
> \## Revision History\
> \* Release v1.04\_231120: Initial development of PG settlement comparison<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":{"PgCompareReceiveRequest":{"type":"object","description":"PG Approval/Settlement Information Receipt Request DTO","properties":{"startDate":{"type":"string","format":"date","description":"Search Start Date"},"endDate":{"type":"string","format":"date","description":"Search End Date"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"siteNo":{"type":"string","description":"Site 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/adjust/pgAdjust/receivePgAdjustList":{"post":{"tags":["PG Settlement Reconciliation"],"summary":"Receive PG Settlement Information","description":"## Function Description\n* Receives and saves PG settlement information for the selected date and PG type code.\n---\n## Detailed Description\n* Receives the PG company's settlement comparison list information for the given PG type code and search start/end date/time.\n* Saves the settlement list information retrieved for PG settlement comparison.\n* Cases where the deposit confirmation status is Y cannot be received.\n* The received data can be viewed on the PG settlement comparison screen.\n---\n## Revision History\n* Release v1.04_231120: Initial development of PG settlement comparison\n","operationId":"savePgApprovalList_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PgCompareReceiveRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Process PG Settlement Comparison Deposit Confirmation/Deposit Confirmation Cancellation

> \## Function Description\
> \* Processes deposit confirmation/deposit confirmation cancellation for a PG settlement comparison.\
> \---\
> \## Detailed Description\
> \* Interface Log Sequence No. and Deposit Confirmation Status are required.\
> \* Required check items for deposit confirmation\
> &#x20; \* Existing data deposit confirmation unprocessed status (N)\
> &#x20; \* Existing data deposit confirmation date/time is null\
> &#x20; \* EC data and PG data deposit amount difference is 0\
> \* Required check items for deposit confirmation cancellation\
> &#x20; \* Existing data deposit confirmation processed status (Y)\
> &#x20; \* Existing data deposit confirmation date/time is not null\
> \---\
> \## Revision History\
> \* Release v1.04\_231120: Initial development of PG settlement comparison<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":{"PgAjstDptCfmAndCnclRequest":{"type":"object","description":"PG Settlement Comparison Deposit Confirmation and Confirmation Cancellation Request DTO","properties":{"infLogSeq":{"type":"string","description":"Interface Log Sequence No."},"dptCfmYn":{"type":"string","description":"Deposit Confirmation Status"}}},"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/adjust/pgAdjust/processDepositConfirmAndCancel":{"post":{"tags":["PG Settlement Reconciliation"],"summary":"Process PG Settlement Comparison Deposit Confirmation/Deposit Confirmation Cancellation","description":"## Function Description\n* Processes deposit confirmation/deposit confirmation cancellation for a PG settlement comparison.\n---\n## Detailed Description\n* Interface Log Sequence No. and Deposit Confirmation Status are required.\n* Required check items for deposit confirmation\n  * Existing data deposit confirmation unprocessed status (N)\n  * Existing data deposit confirmation date/time is null\n  * EC data and PG data deposit amount difference is 0\n* Required check items for deposit confirmation cancellation\n  * Existing data deposit confirmation processed status (Y)\n  * Existing data deposit confirmation date/time is not null\n---\n## Revision History\n* Release v1.04_231120: Initial development of PG settlement comparison\n","operationId":"processDepositConfirmAndCancel","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PgAjstDptCfmAndCnclRequest"}}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve PG Settlement Comparison Summary

> \## Function Description\
> \* Retrieves the summary content of PG settlement comparison.\
> \---\
> \## Detailed Description\
> \* Retrieves the PG settlement comparison summary content matching the conditions passed from the screen.\
> \* Retrieves the amount information for EC system approval/cancellation and PG company approval/cancellation cases on the search date, and the sum of the difference between the expected deposit amount and the deposit amount for both approval/cancellation cases.\
> \* Based on EC system data\
> &#x20; \* Payment Amount: Actual payment amount\
> &#x20; \* Expected Fee: Fee calculated based on the merchant information of the payment data\
> &#x20; \* Expected Deposit Amount: Payment Amount - Expected Fee\
> \* Based on PG data\
> &#x20; \* Approval Amount: PG transaction amount\
> &#x20; \* Payment Fee: PG data payment fee + PG data VAT\
> &#x20; \* Deposit Amount: PG data deposit amount (Approval Amount - Payment Fee)\
> \* Deposit Amount Difference: Expected Deposit Amount - Deposit Amount\
> \---\
> \## Code Reference\
> \* \`\`\`Search Date Type (searchDateType)\`\`\` : aprvDt: Search by approval date, dptDt: Search by deposit date\
> \---\
> \## Revision History\
> \* Release v1.04\_231120: Initial development of PG settlement comparison<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":{"PgAdjCoprRequest":{"type":"object","description":"Retrieve PG Settlement Comparison List Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"searchDateType":{"type":"string","description":"Search Date Basis Type"},"startDate":{"type":"string","format":"date","description":"Search Start Date"},"endDate":{"type":"string","format":"date","description":"Search End Date"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"trdNo":{"type":"string","description":"Transaction Number"},"dptCfmYn":{"type":"string","description":"Deposit Confirmation Status"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"ordNo":{"type":"string","description":"Order No."},"termlId":{"type":"string","description":"Terminal ID"},"payStatCd":{"type":"string","description":"Payment Type"}}},"PgAdjCoprSummaryResponse":{"type":"object","description":"PG Approval Reconciliation Summary Inquiry Response DTO","properties":{"payAmt":{"type":"number","description":"Payment Amount"},"expectedFee":{"type":"integer","format":"int64","description":"Expected Fee"},"expectedDepositAmt":{"type":"integer","format":"int64","description":"Expected Deposit Amount"},"approveAmt":{"type":"integer","format":"int64","description":"Approval Amount"},"paymentFee":{"type":"integer","format":"int64","description":"Payment Fee"},"depositAmt":{"type":"integer","format":"int64","description":"Deposit Amount"},"etcAdjAmt":{"type":"number","description":"Other Adjustment Amount"},"depositAmtDiff":{"type":"integer","format":"int64","description":"Deposit Amount Difference"},"startDate":{"type":"string","format":"date","description":"Search Start Date"},"endDate":{"type":"string","format":"date","description":"Search End Date"}}},"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/adjust/pgAdjust/getPgAdjustCompareSummary":{"post":{"tags":["PG Settlement Reconciliation"],"summary":"Retrieve PG Settlement Comparison Summary","description":"## Function Description\n* Retrieves the summary content of PG settlement comparison.\n---\n## Detailed Description\n* Retrieves the PG settlement comparison summary content matching the conditions passed from the screen.\n* Retrieves the amount information for EC system approval/cancellation and PG company approval/cancellation cases on the search date, and the sum of the difference between the expected deposit amount and the deposit amount for both approval/cancellation cases.\n* Based on EC system data\n  * Payment Amount: Actual payment amount\n  * Expected Fee: Fee calculated based on the merchant information of the payment data\n  * Expected Deposit Amount: Payment Amount - Expected Fee\n* Based on PG data\n  * Approval Amount: PG transaction amount\n  * Payment Fee: PG data payment fee + PG data VAT\n  * Deposit Amount: PG data deposit amount (Approval Amount - Payment Fee)\n* Deposit Amount Difference: Expected Deposit Amount - Deposit Amount\n---\n## Code Reference\n* ```Search Date Type (searchDateType)``` : aprvDt: Search by approval date, dptDt: Search by deposit date\n---\n## Revision History\n* Release v1.04_231120: Initial development of PG settlement comparison\n","operationId":"getPgAdjustCompareSummary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PgAdjCoprRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PgAdjCoprSummaryResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````