GspCardSettlementHeader

    • The header object encapsulates details of a GSP Card settlement, including a unique ID, settlement period, total amount, and the number of settled items.

    • The settlementId is a unique identifier for a settlement report and should be consistent across all related files.

    • The settlementPeriod defines the time range covered by the settlement report using the Interval object.

    • settlementAmount , represented by the Amount object, must equal the total of all events and adjustments within the settlement file.

    • numberOfItems indicates the count of settled items, excluding the header, and is formatted as an Int64Value .

    A header object that is used for the purposes of GSP Card settlement files. It is used to encapsulate the detail surrounding the contained settlement.

    JSON representation 
     { 
 "settlementId" 
 : 
 string 
 , 
 "settlementPeriod" 
 : 
 { 
 object (  Interval 
 
) 
 } 
 , 
 "settlementAmount" 
 : 
 { 
 object (  Amount 
 
) 
 } 
 , 
 "numberOfItems" 
 : 
 string 
 }
    Fields
    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 .
    settlementPeriod

    object ( Interval )

    REQUIRED: The period this settlement report covers.
    settlementAmount

    object ( Amount )

    REQUIRED: This should match the sum of all of the events and adjustments in a settlement file.
    numberOfItems

    string ( Int64Value format)

    REQUIRED: The number of settled items(entries and adjustments). This should exclude the header entry.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: