GspDomesticPayoutRecord

  • GspDomesticPayoutRecord defines the structure for records within a domestic payout file, encompassing header, payment, and refund details.

  • Each record type (header, payment, refund) is identified by the type field within the GspDomesticPayoutRecord.

  • GspDomesticPayoutTransaction provides details for individual payment or refund transactions within the file.

  • Transaction records are linked to a header record using the domesticPayoutId and settlementLineOfBusinessId.

  • Each transaction record includes crucial information like transaction date, Google transaction ID, merchant ID, amount, and processor transaction ID.

Record details in a domestic payout file.

JSON representation
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "header": {
    object (GspDomesticPayoutHeader)
  },
  "payment": {
    object (GspDomesticPayoutTransaction)
  },
  "refund": {
    object (GspDomesticPayoutTransaction)
  }
  // End of mutually exclusive fields.
}
Fields
REQUIRED: Type of record. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
header

object (GspDomesticPayoutHeader)

Header record details.

payment

object (GspDomesticPayoutTransaction)

Payment record details.

refund

object (GspDomesticPayoutTransaction)

Refund record details.

End of mutually exclusive fields.

GspDomesticPayoutTransaction

Transaction record details in a domestic payout file.

There can be multuple transaction records in a file. Each transaction record can be either a payment or a refund. Additionally, transaction records are related to a single DomesticPayoutHeader via domestic payout ID and customer ID (i.e. Settlement Line of Business ID).

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

JSON representation
{
  "domesticPayoutId": string,
  "transactionDate": {
    object (Timestamp)
  },
  "googleTransactionId": string,
  "settlementLineOfBusinessId": string,
  "merchantId": string,
  "amount": {
    object (Amount)
  },
  "processorTransactionId": string
}
Fields
domesticPayoutId

string

REQUIRED: The domestic payout ID that relates this transaction to a header.

transactionDate

object (Timestamp)

REQUIRED: The date of the transaction, in milliseconds.

googleTransactionId

string

REQUIRED: The Google-specific transaction ID (e.g. end-to-end ID).

settlementLineOfBusinessId

string

REQUIRED: The customer ID (i.e. Settlement Line of Business ID).

merchantId

string

REQUIRED: The merchant ID.

amount

object (Amount)

REQUIRED: The amount of the transaction.

processorTransactionId

string

REQUIRED: The "processor transaction ID". This provided by the processor.