GspCardSettlementHeader
Stay organized with collections
Save and categorize content based on your preferences.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eThe GSP Card settlement file uses a header object to encapsulate details about the settlement.\u003c/p\u003e\n"],["\u003cp\u003eThe header object contains the settlement ID, settlement period, settlement amount, and the number of settled items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esettlementId\u003c/code\u003e should be unique for all files related to a specific settlement report.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esettlementAmount\u003c/code\u003e must match the total sum of all events and adjustments included in the settlement file.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003enumberOfItems\u003c/code\u003e field excludes the header entry and reflects only the count of settled entries and adjustments.\u003c/p\u003e\n"]]],["The GSP Card settlement file header contains information about a specific settlement. Key data includes a unique `settlementId` for the report, the `settlementPeriod` it covers, and the `settlementAmount`, which represents the total of all events and adjustments. The `numberOfItems` field indicates the count of settled items, excluding the header. All files associated with a settlement report should share the same `settlementId`. All of the fields are required.\n"],null,["# GspCardSettlementHeader\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nA header object that is used for the purposes of GSP Card settlement files. It is used to encapsulate the detail surrounding the contained settlement.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"settlementId\": string, \"settlementPeriod\": { object (/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Interval) }, \"settlementAmount\": { object (/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Amount) }, \"numberOfItems\": string } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `settlementId` | `string` **REQUIRED** : This should be a unique ID that identifies the settlement report. All files for this settlement report should use the same `settlementId`. |\n| `settlementPeriod` | `object (`[Interval](/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Interval)`)` **REQUIRED**: The period this settlement report covers. |\n| `settlementAmount` | `object (`[Amount](/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Amount)`)` **REQUIRED**: This should match the sum of all of the events and adjustments in a settlement file. |\n| `numberOfItems` | `string (`[Int64Value](https://developers.google.com/discovery/v1/type-format)` format)` **REQUIRED**: The number of settled items(entries and adjustments). This should exclude the header entry. |"]]