Page Summary
-
Domestic payout files can contain multiple header records, each associated with a unique customer ID (Settlement Line of Business ID).
-
Header records provide details such as settlement date, merchant ID, payment and refund counts and amounts, marketplace and incentive amounts, and adjustments.
-
The
domesticPayoutIdfield combines a prefix number with the settlement date to uniquely identify each payout. -
All header record fields are required, including either an
adjustmentCreditoradjustmentDebitto represent adjustments. -
File consumers can dynamically determine the record type using the
DomesticPayoutRecord.typefield.
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 |
|---|
{ "domesticPayoutId" : string , "settlementDate" : { object ( |
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.
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.
