GspDomesticPayoutHeader
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\u003eDomestic payout files can contain multiple header records, each associated with a unique customer ID (Settlement Line of Business ID).\u003c/p\u003e\n"],["\u003cp\u003eHeader records provide details such as settlement date, merchant ID, payment and refund counts and amounts, marketplace and incentive amounts, and adjustments.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edomesticPayoutId\u003c/code\u003e field combines a prefix number with the settlement date to uniquely identify each payout.\u003c/p\u003e\n"],["\u003cp\u003eAll header record fields are required, including either an \u003ccode\u003eadjustmentCredit\u003c/code\u003e or \u003ccode\u003eadjustmentDebit\u003c/code\u003e to represent adjustments.\u003c/p\u003e\n"],["\u003cp\u003eFile consumers can dynamically determine the record type using the \u003ccode\u003eDomesticPayoutRecord.type\u003c/code\u003e field.\u003c/p\u003e\n"]]],["Domestic payout files can contain multiple header records, with one per customer ID. Each header includes a unique `domesticPayoutId`, `settlementDate`, `settlementLineOfBusinessId`, and `merchantId`. The record specifies `paymentRecordCount`, `refundRecordCount`, `paymentGrossAmount`, `refundGrossAmount`, `marketplaceAmount`, and `incentiveAmount`. An `adjustment`, either a `credit` or `debit`, is also required. The type of the record can be found in the `DomesticPayoutRecord.type`.\n"],null,["# GspDomesticPayoutHeader\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nHeader record details in a domestic payout file.\n\nThere can be multiple header records in a file, but only a single header per each customer ID (i.e. Settlement Line of Business ID).\n\nThe Record type can be dynamically determined by the file consumer using the `DomesticPayoutRecord.type` field.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"domesticPayoutId\": string, \"settlementDate\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Timestamp) }, \"settlementLineOfBusinessId\": string, \"merchantId\": string, \"paymentRecordCount\": string, \"refundRecordCount\": string, \"paymentGrossAmount\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) }, \"refundGrossAmount\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) }, \"marketplaceAmount\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) }, \"incentiveAmount\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) }, // Union field `adjustment` can be only one of the following: \"adjustmentCredit\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) }, \"adjustmentDebit\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) } // End of list of possible types for union field `adjustment`. } ``` |\n\n| Fields ||\n|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `settlementDate` | `object (`[Timestamp](/pay/card-fop-v1/google-card-fop-api/settlementNotification#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. |\n| `settlementLineOfBusinessId` | `string` **REQUIRED**: The customer ID (i.e. Settlement Line of Business ID). |\n| `merchantId` | `string` **REQUIRED**: The merchant ID. |\n| `paymentRecordCount` | `string (`[Int64Value](https://developers.google.com/discovery/v1/type-format)` format)` **REQUIRED**: The number of payment records associated with this header. |\n| `refundRecordCount` | `string (`[Int64Value](https://developers.google.com/discovery/v1/type-format)` format)` **REQUIRED**: The number of refund records associated with this header. |\n| `paymentGrossAmount` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` **REQUIRED**: The gross amount of all payment records associated with this header. |\n| `refundGrossAmount` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` **REQUIRED**: The gross amount of all refund records associated with this header. |\n| `marketplaceAmount` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` **REQUIRED**: The \"marketplace\" amount associated with this header. |\n| `incentiveAmount` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` **REQUIRED**: The \"incentive\" amount associated with this header. |\n| Union field `adjustment`. **REQUIRED** : The \"adjustment\" associated with this header. `adjustment` can be only one of the following: ||\n| `adjustmentCredit` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` The credit \"adjustment\" amount associated with this header. |\n| `adjustmentDebit` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` **REQUIRED**: The debit \"adjustment\" amount associated with this header. |"]]