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,
  "openingBalance": {
    object (Amount)
  },
  "closingBalance": {
    object (Amount)
  },
  "settlementPaymentDetails": {
    object (SettlementPaymentDetails)
  }
}
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.
openingBalance

object (Amount)

OPTIONAL: The balance at the open of the settlement period. Part of the Balance Equation: closingBalance = openingBalance + settlementAmount - settlementPaymentAmount.
closingBalance

object (Amount)

OPTIONAL: The balance at the close of the settlement period. Part of the Balance Equation: closingBalance = openingBalance + settlementAmount - settlementPaymentAmount.
settlementPaymentDetails

object (SettlementPaymentDetails)

OPTIONAL: Details of the settlement payment. When this field is not set, it is assumed that no settlement payment was made for this settlement period, e.g., due to a negative balance.

SettlementPaymentDetails

Details pertaining to the settlement payment.

JSON representation 
{
  "settlementPaymentAmount": {
    object (Amount)
  },
  "settlementIds": [
    string
  ]
}
Fields
settlementPaymentAmount

object (Amount)

REQUIRED: The amount being paid to settle a balance. Part of the Balance Equation: closingBalance = openingBalance + settlementAmount - settlementPaymentAmount.
settlementIds[]

string

REQUIRED: The settlement IDs that were used to make the payment. This is used to identify the settlement reports that are being paid. Typically, settlementId; however, when the openingBalance is negative, multiple settlement reports are included in a single settlement payment.