GspDomesticPayoutHeader

JSON representation

Header record details in a domestic payout file.

There can be multiple header records in a file, but only a single header per each customer ID (i.e. Settlement Line of Business ID).

The Record type can be dynamically determined by the file consumer using the DomesticPayoutRecord.type field.

JSON representation

JSON representation
{ "domesticPayoutId": string, "settlementDate": { object (`Timestamp`) }, "settlementLineOfBusinessId": string, "merchantId": string, "paymentRecordCount": string, "refundRecordCount": string, "paymentGrossAmount": { object (`Amount`) }, "refundGrossAmount": { object (`Amount`) }, "marketplaceAmount": { object (`Amount`) }, "incentiveAmount": { object (`Amount`) }, // Union field `adjustment` can be only one of the following: "adjustmentCredit": { object (`Amount`) }, "adjustmentDebit": { object (`Amount`) } // End of list of possible types for union field `adjustment`. }

{
  "domesticPayoutId": string,
  "settlementDate": {
    object (Timestamp)
  },
  "settlementLineOfBusinessId": string,
  "merchantId": string,
  "paymentRecordCount": string,
  "refundRecordCount": string,
  "paymentGrossAmount": {
    object (Amount)
  },
  "refundGrossAmount": {
    object (Amount)
  },
  "marketplaceAmount": {
    object (Amount)
  },
  "incentiveAmount": {
    object (Amount)
  },

  // Union field adjustment can be only one of the following:
  "adjustmentCredit": {
    object (Amount)
  },
  "adjustmentDebit": {
    object (Amount)
  }
  // End of list of possible types for union field adjustment.
}

Fields
`domesticPayoutId`	`string` REQUIRED: The Domestic Payout ID. As populated in the file, a combination of a non-zero, non-negative prefix number and the settlement date.
`settlementDate`	`object (Timestamp)` REQUIRED: The settlement date, in milliseconds. This date needs to be greater than, or equal to, the system date. Usually this is the date of the file creation.
`settlementLineOfBusinessId`	`string` REQUIRED: The customer ID (i.e. Settlement Line of Business ID).
`merchantId`	`string` REQUIRED: The merchant ID.
`paymentRecordCount`	`string (Int64Value format)` REQUIRED: The number of payment records associated with this header.
`refundRecordCount`	`string (Int64Value format)` REQUIRED: The number of refund records associated with this header.
`paymentGrossAmount`	`object (Amount)` REQUIRED: The gross amount of all payment records associated with this header.
`refundGrossAmount`	`object (Amount)` REQUIRED: The gross amount of all refund records associated with this header.
`marketplaceAmount`	`object (Amount)` REQUIRED: The "marketplace" amount associated with this header.
`incentiveAmount`	`object (Amount)` REQUIRED: The "incentive" amount associated with this header.
Union field `adjustment`. REQUIRED: The "adjustment" associated with this header. `adjustment` can be only one of the following:
`adjustmentCredit`	`object (Amount)` The credit "adjustment" amount associated with this header.
`adjustmentDebit`	`object (Amount)` REQUIRED: The debit "adjustment" amount associated with this header.