GspCardSettlementEntry

Represents an individual settlement line item in a settlement file provided by the payment integrator to settle transactions for GSP cards.

JSON representation 
{
  "entryId": string,
  "settlementEntryType": {
    object (SettlementEntryType)
  }
}
Fields
entryId

string (Int64Value format)

REQUIRED: A non-zero and non-negative number within the settlement file that uniquely identifies a settlement line.
settlementEntryType

object (SettlementEntryType)

REQUIRED: The type of the settlement entry.

SettlementEntryType

The type of settlement entry.

JSON representation 
{

  // Union field settlement_entry can be only one of the following:
  "captureEvent": {
    object (CaptureEvent)
  },
  "refundEvent": {
    object (RefundEvent)
  },
  "reverseRefundEvent": {
    object (ReverseRefundEvent)
  },
  "chargebackEvent": {
    object (ChargebackEvent)
  },
  "reverseChargebackEvent": {
    object (ReverseChargebackEvent)
  },
  "fundsReservationEvent": {
    object (FundsReservationEvent)
  },
  "aggregateAdjustment": {
    object (AggregateAdjustment)
  },
  "miscellaneousAdjustment": {
    object (MiscellaneousAdjustment)
  }
  // End of list of possible types for union field settlement_entry.
}
Fields
Union field settlement_entry. REQUIRED: Represents a single event in this settlement file. settlement_entry can be only one of the following:
captureEvent

object (CaptureEvent)

Details surrounding a capture event that is being settled.
refundEvent

object (RefundEvent)

Details surrounding a refund event that is being settled.
reverseRefundEvent

object (ReverseRefundEvent)

Details surrounding a reverse refund event that is being settled.
chargebackEvent

object (ChargebackEvent)

Details surrounding a chargeback event that is being settled.
reverseChargebackEvent

object (ReverseChargebackEvent)

Details surrounding a reverse chargeback event that is bing settled.
fundsReservationEvent

object (FundsReservationEvent)

Details surrounding a funds reservation event that is being settled.
aggregateAdjustment

object (AggregateAdjustment)

Details surrounding a aggregate adjustment event that is being settled.
miscellaneousAdjustment

object (MiscellaneousAdjustment)

Details surrounding a miscellaneous adjustment that is being settled any usages of this type should be communicated with Google prior to usage.

RefundEvent

This represents a refund where money is being returned to a customer. It will be associated with a refund event.

JSON representation 
{
  "asynchronousRefundRequestId": string,
  "paymentIntegratorRefundId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}
Fields
asynchronousRefundRequestId

string

REQUIRED: requestId that was sent by Google for the asynchronousRefund request that this settlementEvent pertains to.
paymentIntegratorRefundId

string

REQUIRED: An ID that is generated by the payment integrator that can be used to refer to this refund event.
eventCharge

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.
eventPresentmentDetails

object (EventPresentmentDetails)

OPTIONAL: If the settlement currency is different than the purchase currency then this field should be used to specify details about the event in the original purchase currency and the conversion to the settlement amount.
eventFee

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google. If the fee is broken down into several parts, this value is the sum of them and the amount settled. A breakdown of the fee can be specified in the eventFeeBreakdown.

For example, if an agreement says that Google will pay 1% of the eventCharge to the payment integrator, and will reverse that 1% upon refund of that transaction, then the capture fee will be negative and upon refund the refund fee will be positive.
eventFeeBreakdown

object (EventFeeBreakdown)

OPTIONAL: This is a breakdown of the eventFee. It is used for reporting purposes and is not factored into the settlementAmount. It is used to understand what parts of the eventFee are attributable to what sources.
eventVat

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.

This is the value-added-tax (VAT) for the eventFee. This amount is in addition to the fee. e.g. If the eventCharge is $2.00, the eventFee is -$0.20 and the eventVat is -$0.05 the total settlement value for this event would be $1.75.

ReverseRefundEvent

This represents a reverse refund. It is associated with a reverseRefundNotification and typically is used when a refund was performed but the issuing bank was unable to return funds to the customer, so they are being returned to Google.

JSON representation 
{
  "asynchronousRefundRequestId": string,
  "paymentIntegratorReverseRefundNotificationRequestId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}
Fields
asynchronousRefundRequestId

string

REQUIRED: requestId that was sent by Google for the refund request that this reverseRefundEvent is reversing.
paymentIntegratorReverseRefundNotificationRequestId

string

REQUIRED: This is the requestId generated by the payment integrator in the reversereRefundNotification request.
eventCharge

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.
eventPresentmentDetails

object (EventPresentmentDetails)

OPTIONAL: If the settlement currency is different than the purchase currency then this field should be used to specify details about the event in the original purchase currency and the conversion to the settlement amount.
eventFee

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google. If the fee is broken down into several parts, this value is the sum of them and the amount settled. A breakdown of the fee can be specified in the eventFeeBreakdown.

For example, if an agreement says that Google will pay 1% of the eventCharge to the payment integrator, and will reverse that 1% upon refund of that transaction, then the capture fee will be negative and upon refund the refund fee will be positive.
eventFeeBreakdown

object (EventFeeBreakdown)

OPTIONAL: This is a breakdown of the eventFee. It is used for reporting purposes and is not factored into the settlementAmount. It is used to understand what parts of the eventFee are attributable to what sources.
eventVat

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.

This is the value-added-tax (VAT) for the eventFee. This amount is in addition to the fee. e.g. If the eventCharge is $2.00, the eventFee is -$0.20 and the eventVat is -$0.05 the total settlement value for this event would be $1.75.

ReverseChargebackEvent

This represents a reverse chargeback. It is associated with a reverseChargebackNotification and is used when Google successfully disputes a chargebackNotification. The funds are being returned to Google.

JSON representation 
{
  "captureRequestId": string,
  "paymentIntegratorReverseChargebackNotificationRequestId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}
Fields
captureRequestId

string

REQUIRED: requestId that was sent by Google for the capture request that this settlementEvent pertains to.
paymentIntegratorReverseChargebackNotificationRequestId

string

REQUIRED: This is the requestId generated by the payment integrator in the reversereChargebackNotification request.
eventCharge

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.
eventPresentmentDetails

object (EventPresentmentDetails)

OPTIONAL: If the settlement currency is different than the purchase currency then this field should be used to specify details about the event in the original purchase currency and the conversion to the settlement amount.
eventFee

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google. If the fee is broken down into several parts, this value is the sum of them and the amount settled. A breakdown of the fee can be specified in the eventFeeBreakdown.

For example, if an agreement says that Google will pay 1% of the eventCharge to the payment integrator, and will reverse that 1% upon refund of that transaction, then the capture fee will be negative and upon refund the refund fee will be positive.
eventFeeBreakdown

object (EventFeeBreakdown)

OPTIONAL: This is a breakdown of the eventFee. It is used for reporting purposes and is not factored into the settlementAmount. It is used to understand what parts of the eventFee are attributable to what sources.
eventVat

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.

This is the value-added-tax (VAT) for the eventFee. This amount is in addition to the fee. e.g. If the eventCharge is $2.00, the eventFee is -$0.20 and the eventVat is -$0.05 the total settlement value for this event would be $1.75.

MiscellaneousAdjustment

Miscellaneous Adjustments should only be used in exceptional situations when no other entries are suitable to represent money movement. Google will monitor the usage of this type of entry and consider it a bug if it's used systematically.

JSON representation 
{
  "adjustmentDescription": string,
  "adjustmentAmount": {
    object (Amount)
  }
}
Fields
adjustmentDescription

string

REQUIRED: Adjustment description should clearly explain the nature and exceptional circumstances of the adjustment.
adjustmentAmount

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.

The amount of the adjustment that will be factored into the settlementAmount for this settlementNotificationRequest.